Excel.PageBreak class
- Extends
Remarques
Utilisateur
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/manage-page-breaks.yaml
// Inspect the first horizontal break and locate the cell immediately after it.
await Excel.run(async (context) => {
const sheet: Excel.Worksheet = context.workbook.worksheets.getItem("Sample");
const horizontalBreaks: Excel.PageBreakCollection = sheet.horizontalPageBreaks;
const horizontalCount: OfficeExtension.ClientResult<number> = horizontalBreaks.getCount();
await context.sync();
if (horizontalCount.value === 0) {
console.warn("No horizontal page breaks. Choose Add page breaks first.");
return;
}
const firstBreak: Excel.PageBreak = horizontalBreaks.getItem(0);
const cellAfterBreak: Excel.Range = firstBreak.getCellAfterBreak();
firstBreak.load("rowIndex, columnIndex");
cellAfterBreak.load("address");
await context.sync();
console.log("First horizontal page break (zero-based indexes):", {
rowIndex: firstBreak.rowIndex,
columnIndex: firstBreak.columnIndex,
cellAfterBreak: cellAfterBreak.address
});
});
Propriétés
| column |
Spécifie l’index de colonne pour le saut de page. |
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| row |
Spécifie l’index de ligne pour le saut de page. |
Méthodes
| delete() | Supprime un objet de saut de page. |
| get |
Obtient la première cellule après le saut de page. |
| 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 |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
columnIndex
Spécifie l’index de colonne pour le saut de page.
readonly columnIndex: number;Valeur de propriété
number
Remarques
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é
rowIndex
Spécifie l’index de ligne pour le saut de page.
readonly rowIndex: number;Valeur de propriété
number
Remarques
Détails de la méthode
delete()
Supprime un objet de saut de page.
delete(): void;Retours
void
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/manage-page-breaks.yaml
// Delete a single horizontal break while leaving the other breaks unchanged.
await Excel.run(async (context) => {
const sheet: Excel.Worksheet = context.workbook.worksheets.getItem("Sample");
const horizontalBreaks: Excel.PageBreakCollection = sheet.horizontalPageBreaks;
const horizontalCount: OfficeExtension.ClientResult<number> = horizontalBreaks.getCount();
await context.sync();
if (horizontalCount.value === 0) {
console.warn("No horizontal page breaks. Choose Add page breaks first.");
return;
}
const firstBreak: Excel.PageBreak = horizontalBreaks.getItem(0);
firstBreak.delete();
await context.sync();
console.log("Deleted the first horizontal page break. Choose List page breaks to inspect the remaining breaks.");
});
getCellAfterBreak()
Obtient la première cellule après le saut de page.
getCellAfterBreak(): Excel.Range;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?: Excel.Interfaces.PageBreakLoadOptions): Excel.PageBreak;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.PageBreak;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?: {
select?: string;
expand?: string;
}): Excel.PageBreak;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
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.PageBreak est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.PageBreakDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Excel.Interfaces.PageBreakData;