Excel.PageBreakCollection class
- Extends
Remarques
[Jeu d’API : ExcelApi 1.9]
Propriétés
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| items | Obtient l’élément enfant chargé dans cette collection de sites. |
Méthodes
| add(page |
Ajoute un saut de page avant la cellule en haut à gauche de la plage spécifiée. |
| get |
Obtient le nombre de pages de la collection. |
| get |
Obtient un objet de saut de page via l’index. |
| 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 |
| remove |
Redéfinit tous les sauts de page de la collection. |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
context
Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
context: RequestContext;Valeur de propriété
items
Obtient l’élément enfant chargé dans cette collection de sites.
readonly items: Excel.PageBreak[];Valeur de propriété
Détails de la méthode
add(pageBreakRange)
Ajoute un saut de page avant la cellule en haut à gauche de la plage spécifiée.
add(pageBreakRange: Range | string): Excel.PageBreak;Paramètres
- pageBreakRange
-
Excel.Range | string
Plage immédiatement après le saut de page à ajouter.
Retours
Remarques
[Jeu d’API : ExcelApi 1.9]
getCount()
Obtient le nombre de pages de la collection.
getCount(): OfficeExtension.ClientResult<number>;Retours
OfficeExtension.ClientResult<number>
Remarques
[Jeu d’API : ExcelApi 1.9]
getItem(index)
Obtient un objet de saut de page via l’index.
getItem(index: number): Excel.PageBreak;Paramètres
- index
-
number
Index du saut de page.
Retours
Remarques
[Jeu d’API : ExcelApi 1.9]
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?: Excel.Interfaces.PageBreakCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PageBreakCollection;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[]): Excel.PageBreakCollection;Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.
Retours
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?: OfficeExtension.LoadOption): Excel.PageBreakCollection;Paramètres
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
removePageBreaks()
Redéfinit tous les sauts de page de la collection.
removePageBreaks(): void;Retours
void
Remarques
[Jeu d’API : ExcelApi 1.9]
toJSON()
Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.PageBreakCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.PageBreakCollectionDataqui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.
toJSON(): Excel.Interfaces.PageBreakCollectionData;