OneNote.Paragraph class
Conteneur pour le contenu visible d’une page. Un paragraphe peut contenir n’importe quel type de contenu ParagraphType.
- Extends
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Propriétés
context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
id | Obtient l’ID de l’objet Paragraph. En lecture seule. |
image | Renvoie l’objet Image dans le paragraphe. Renvoie une exception si ParagraphType n’est pas défini sur Image. En lecture seule. |
ink |
Obtient la collection Ink dans le paragraphe. Renvoie une exception si ParagraphType n’est pas défini sur Ink. En lecture seule. |
outline | Renvoie l’objet Outline qui contient le paragraphe. En lecture seule. |
paragraphs | Collection de paragraphes sous ce paragraphe. Lecture seule |
parent |
Obtient l’objet de paragraphe parent. Indique si un paragraphe parent n’existe pas. En lecture seule. |
parent |
Obtient l’objet de paragraphe parent. Renvoie la valeur null si un paragraphe parent n’existe pas. En lecture seule. |
parent |
Obtient l’objet TableCell qui contient le paragraphe s’il en existe un. Si le parent n’est pas un objet TableCell, renvoie ItemNotFound. En lecture seule. |
parent |
Obtient l’objet TableCell qui contient le paragraphe s’il en existe un. Si le parent n’est pas un objet TableCell, renvoie la valeur null. En lecture seule. |
rich |
Renvoie l’objet RichText du paragraphe. Renvoie une exception si ParagraphType n’est pas défini sur RichText. Lecture seule |
table | Obtient l’objet Table dans le paragraphe. Renvoie une exception si ParagraphType n’est pas défini sur Table. En lecture seule. |
type | Obtient le type de l’objet Paragraph. En lecture seule. |
Méthodes
add |
Ajoutez NoteTag au paragraphe. |
add |
Ajoutez NoteTag au paragraphe. |
delete() | Supprime le paragraphe. |
get |
Obtenir les informations de liste du paragraphe |
insert |
Insère le contenu HTML spécifié. |
insert |
Insère le contenu HTML spécifié. |
insert |
Insère l’image à l’emplacement d’insertion spécifié. |
insert |
Insère l’image à l’emplacement d’insertion spécifié. |
insert |
Insère le texte du paragraphe à l’emplacement d’insertion spécifié. |
insert |
Insère le texte du paragraphe à l’emplacement d’insertion spécifié. |
insert |
Ajoute un tableau avec le nombre spécifié de lignes et de colonnes avant ou après le paragraphe en cours. |
insert |
Ajoute un tableau avec le nombre spécifié de lignes et de colonnes avant ou après le paragraphe en cours. |
load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
set(properties, options) | Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type. |
set(properties) | Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant. |
toJSON() | Remplace la méthode JavaScript |
track() | Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour |
untrack() | Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour |
Détails de la propriété
context
Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
context: RequestContext;
Valeur de propriété
id
Obtient l’ID de l’objet Paragraph. En lecture seule.
readonly id: string;
Valeur de propriété
string
Remarques
image
Renvoie l’objet Image dans le paragraphe. Renvoie une exception si ParagraphType n’est pas défini sur Image. En lecture seule.
readonly image: OneNote.Image;
Valeur de propriété
Remarques
inkWords
Obtient la collection Ink dans le paragraphe. Renvoie une exception si ParagraphType n’est pas défini sur Ink. En lecture seule.
readonly inkWords: OneNote.InkWordCollection;
Valeur de propriété
Remarques
outline
Renvoie l’objet Outline qui contient le paragraphe. En lecture seule.
readonly outline: OneNote.Outline;
Valeur de propriété
Remarques
paragraphs
Collection de paragraphes sous ce paragraphe. Lecture seule
readonly paragraphs: OneNote.ParagraphCollection;
Valeur de propriété
Remarques
parentParagraph
Obtient l’objet de paragraphe parent. Indique si un paragraphe parent n’existe pas. En lecture seule.
readonly parentParagraph: OneNote.Paragraph;
Valeur de propriété
Remarques
parentParagraphOrNull
Obtient l’objet de paragraphe parent. Renvoie la valeur null si un paragraphe parent n’existe pas. En lecture seule.
readonly parentParagraphOrNull: OneNote.Paragraph;
Valeur de propriété
Remarques
parentTableCell
Obtient l’objet TableCell qui contient le paragraphe s’il en existe un. Si le parent n’est pas un objet TableCell, renvoie ItemNotFound. En lecture seule.
readonly parentTableCell: OneNote.TableCell;
Valeur de propriété
Remarques
parentTableCellOrNull
Obtient l’objet TableCell qui contient le paragraphe s’il en existe un. Si le parent n’est pas un objet TableCell, renvoie la valeur null. En lecture seule.
readonly parentTableCellOrNull: OneNote.TableCell;
Valeur de propriété
Remarques
richText
Renvoie l’objet RichText du paragraphe. Renvoie une exception si ParagraphType n’est pas défini sur RichText. Lecture seule
readonly richText: OneNote.RichText;
Valeur de propriété
Remarques
table
Obtient l’objet Table dans le paragraphe. Renvoie une exception si ParagraphType n’est pas défini sur Table. En lecture seule.
readonly table: OneNote.Table;
Valeur de propriété
Remarques
type
Obtient le type de l’objet Paragraph. En lecture seule.
readonly type: OneNote.ParagraphType | "RichText" | "Image" | "Table" | "Ink" | "Other";
Valeur de propriété
OneNote.ParagraphType | "RichText" | "Image" | "Table" | "Ink" | "Other"
Remarques
Détails de la méthode
addNoteTag(type, status)
Ajoutez NoteTag au paragraphe.
addNoteTag(type: OneNote.NoteTagType, status: OneNote.NoteTagStatus): OneNote.NoteTag;
Paramètres
- type
- OneNote.NoteTagType
Type de NoteTag.
- status
- OneNote.NoteTagStatus
État du Bloc-notes.
Retours
Remarques
addNoteTag(typeString, statusString)
Ajoutez NoteTag au paragraphe.
addNoteTag(typeString: "Unknown" | "ToDo" | "Important" | "Question" | "Contact" | "Address" | "PhoneNumber" | "Website" | "Idea" | "Critical" | "ToDoPriority1" | "ToDoPriority2", statusString: "Unknown" | "Normal" | "Completed" | "Disabled" | "OutlookTask" | "TaskNotSyncedYet" | "TaskRemoved"): OneNote.NoteTag;
Paramètres
- typeString
-
"Unknown" | "ToDo" | "Important" | "Question" | "Contact" | "Address" | "PhoneNumber" | "Website" | "Idea" | "Critical" | "ToDoPriority1" | "ToDoPriority2"
Type de NoteTag.
- statusString
-
"Unknown" | "Normal" | "Completed" | "Disabled" | "OutlookTask" | "TaskNotSyncedYet" | "TaskRemoved"
État du Bloc-notes.
Retours
Remarques
delete()
Supprime le paragraphe.
delete(): void;
Retours
void
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Exemples
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()
Obtenir les informations de liste du paragraphe
getParagraphInfo(): OfficeExtension.ClientResult<OneNote.ParagraphInfo>;
Retours
Remarques
insertHtmlAsSibling(insertLocation, html)
Insère le contenu HTML spécifié.
insertHtmlAsSibling(insertLocation: OneNote.InsertLocation, html: string): void;
Paramètres
- insertLocation
- OneNote.InsertLocation
Emplacement du nouveau contenu relatif au paragraphe actif.
- html
-
string
Chaîne HTML qui décrit la présentation visuelle du contenu. Consultez HTML pris en charge pour l’API JavaScript des compléments OneNote.
Retours
void
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Exemples
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)
Insère le contenu HTML spécifié.
insertHtmlAsSibling(insertLocationString: "Before" | "After", html: string): void;
Paramètres
- insertLocationString
-
"Before" | "After"
Emplacement du nouveau contenu relatif au paragraphe actif.
- html
-
string
Chaîne HTML qui décrit la présentation visuelle du contenu. Consultez HTML pris en charge pour l’API JavaScript des compléments OneNote.
Retours
void
Remarques
insertImageAsSibling(insertLocation, base64EncodedImage, width, height)
Insère l’image à l’emplacement d’insertion spécifié.
insertImageAsSibling(insertLocation: OneNote.InsertLocation, base64EncodedImage: string, width: number, height: number): OneNote.Image;
Paramètres
- insertLocation
- OneNote.InsertLocation
Emplacement du tableau relatif au paragraphe actif.
- base64EncodedImage
-
string
Chaîne HTML à ajouter.
- width
-
number
Optional. Largeur de l’unité des points. La valeur par défaut est Null et la largeur d’image est respectée.
- height
-
number
Optional. Hauteur de l’unité des points. La valeur par défaut est Null et la hauteur d’image est respectée.
Retours
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Exemples
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)
Insère l’image à l’emplacement d’insertion spécifié.
insertImageAsSibling(insertLocationString: "Before" | "After", base64EncodedImage: string, width: number, height: number): OneNote.Image;
Paramètres
- insertLocationString
-
"Before" | "After"
Emplacement du tableau relatif au paragraphe actif.
- base64EncodedImage
-
string
Chaîne HTML à ajouter.
- width
-
number
Optional. Largeur de l’unité des points. La valeur par défaut est Null et la largeur d’image est respectée.
- height
-
number
Optional. Hauteur de l’unité des points. La valeur par défaut est Null et la hauteur d’image est respectée.
Retours
Remarques
insertRichTextAsSibling(insertLocation, paragraphText)
Insère le texte du paragraphe à l’emplacement d’insertion spécifié.
insertRichTextAsSibling(insertLocation: OneNote.InsertLocation, paragraphText: string): OneNote.RichText;
Paramètres
- insertLocation
- OneNote.InsertLocation
Emplacement du tableau relatif au paragraphe actif.
- paragraphText
-
string
Chaîne HTML à ajouter.
Retours
Remarques
[ Ensemble d’API : OneNoteApi 1.1 ]
Exemples
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)
Insère le texte du paragraphe à l’emplacement d’insertion spécifié.
insertRichTextAsSibling(insertLocationString: "Before" | "After", paragraphText: string): OneNote.RichText;
Paramètres
- insertLocationString
-
"Before" | "After"
Emplacement du tableau relatif au paragraphe actif.
- paragraphText
-
string
Chaîne HTML à ajouter.
Retours
Remarques
insertTableAsSibling(insertLocation, rowCount, columnCount, values)
Ajoute un tableau avec le nombre spécifié de lignes et de colonnes avant ou après le paragraphe en cours.
insertTableAsSibling(insertLocation: OneNote.InsertLocation, rowCount: number, columnCount: number, values?: string[][]): OneNote.Table;
Paramètres
- insertLocation
- OneNote.InsertLocation
Emplacement du tableau relatif au paragraphe actif.
- rowCount
-
number
Nombre de lignes du tableau.
- columnCount
-
number
Nombre de colonnes du tableau.
- values
-
string[][]
Tableau 2D facultatif. Les cellules sont remplies si les chaînes correspondantes sont spécifiées dans le tableau.
Retours
Remarques
insertTableAsSibling(insertLocationString, rowCount, columnCount, values)
Ajoute un tableau avec le nombre spécifié de lignes et de colonnes avant ou après le paragraphe en cours.
insertTableAsSibling(insertLocationString: "Before" | "After", rowCount: number, columnCount: number, values?: string[][]): OneNote.Table;
Paramètres
- insertLocationString
-
"Before" | "After"
Emplacement du tableau relatif au paragraphe actif.
- rowCount
-
number
Nombre de lignes du tableau.
- columnCount
-
number
Nombre de colonnes du tableau.
- values
-
string[][]
Tableau 2D facultatif. Les cellules sont remplies si les chaînes correspondantes sont spécifiées dans le tableau.
Retours
Remarques
load(options)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync()
avant de lire les propriétés.
load(options?: OneNote.Interfaces.ParagraphLoadOptions): OneNote.Paragraph;
Paramètres
Fournit des options pour les propriétés de l’objet à charger.
Retours
load(propertyNames)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync()
avant de lire les propriétés.
load(propertyNames?: string | string[]): OneNote.Paragraph;
Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.
Retours
Exemples
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)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync()
avant de lire les propriétés.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): OneNote.Paragraph;
Paramètres
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand
est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.
Retours
set(properties, options)
Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties: Interfaces.ParagraphUpdateData, options?: OfficeExtension.UpdateOptions): void;
Paramètres
- properties
- OneNote.Interfaces.ParagraphUpdateData
Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.
- options
- OfficeExtension.UpdateOptions
Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.
Retours
void
set(properties)
Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
set(properties: OneNote.Paragraph): void;
Paramètres
- properties
- OneNote.Paragraph
Retours
void
toJSON()
Remplace la méthode JavaScript toJSON()
afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify()
. (JSON.stringify
appelle à son tour la toJSON
méthode de l’objet qui lui est passé.) Alors que l’objet OneNote.Paragraph d’origine est un objet API, la toJSON
méthode renvoie un objet JavaScript brut (typé en tant OneNote.Interfaces.ParagraphData
que ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): OneNote.Interfaces.ParagraphData;
Retours
track()
Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject)
. Si vous utilisez cet objet sur des .sync
appels et en dehors de l’exécution séquentielle d’un lot . run et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous deviez avoir ajouté l’objet à la collection d’objets suivie lors de la création de l’objet pour la première fois.
track(): OneNote.Paragraph;
Retours
untrack()
Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject)
. Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync()
avant que la libération de la mémoire ne prenne effet.
untrack(): OneNote.Paragraph;