Word.PageSetup class

Indique si Microsoft Word imprime le document sous forme de livret.

bookFoldPrinting: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie le nombre de pages de chaque livret.

bookFoldPrintingSheets: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Indique si Microsoft Word inverse l’ordre d’impression pour l’impression de la mise en page de livres de documents bidirectionnels ou en langues asiatiques.

bookFoldReversePrinting: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie la distance (en points) entre le bord inférieur de la page et la limite inférieure du corps de texte.

bottomMargin: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie le nombre de caractères par ligne dans la grille du document.

charsLine: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

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é

Indique si la première page comporte un en-tête et un pied de page différents.

differentFirstPageHeaderFooter: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie la distance entre le pied de page et le bas de la page en points.

footerDistance: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie la quantité (en points) d’espace de marge supplémentaire ajouté à chaque page d’un document ou d’une section pour la reliure.

gutter: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie de quel côté la gouttière apparaît dans un document.

gutterPosition: Word.GutterPosition | "Left" | "Right" | "Top";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Indique si Microsoft Word utilise des gouttières pour le document actif basées sur une langue de droite à gauche ou de gauche à droite.

gutterStyle: Word.GutterStyle | "Bidirectional" | "Latin";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie la distance entre l’en-tête et le haut de la page en points.

headerDistance: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie le mode de mise en page du document actif.

layoutMode: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie la distance (en points) entre le bord gauche de la page et la limite gauche du corps de texte.

leftMargin: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie un LineNumbering objet qui représente les numéros de ligne de l’objet PageSetup .

lineNumbering: Word.LineNumbering;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie le nombre de lignes par page dans la grille du document.

linesPage: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Indique si les marges intérieure et extérieure des pages en vis-à-vis ont la même largeur.

mirrorMargins: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Indique si les pages paires et impaires ont des en-têtes et pieds de page différents.

oddAndEvenPagesHeaderFooter: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie l’orientation de la page.

orientation: Word.PageOrientation | "Portrait" | "Landscape";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie la hauteur de page en points.

pageHeight: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie la largeur de la page en points.

pageWidth: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie le format papier de la page.

paperSize: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie la distance (en points) entre le bord droit de la page et la limite droite du corps de texte.

rightMargin: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie l’ordre de lecture et l’alignement des sections spécifiées.

sectionDirection: Word.SectionDirection | "RightToLeft" | "LeftToRight";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie le type de saut de section de l’objet spécifié.

sectionStart: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Indique si la grille doit être affichée.

showGrid: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie si les notes de fin sont imprimées à la fin de la section suivante qui ne supprime pas les notes de fin.

suppressEndnotes: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Obtient un TextColumnCollection objet qui représente l’ensemble des colonnes de texte de l’objet PageSetup .

readonly textColumns: Word.TextColumnCollection;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie la marge supérieure de la page en points.

topMargin: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie si vous souhaitez imprimer deux pages par feuille.

twoPagesOnOne: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie l’alignement vertical du texte sur chaque page d’un document ou d’une section.

verticalAlignment: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

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?: Word.Interfaces.PageSetupLoadOptions): Word.PageSetup;

Paramètres

Retours

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[]): Word.PageSetup;

Paramètres

Retours

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;
        }): Word.PageSetup;

Paramètres

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.PageSetupUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Word.PageSetup): void;

Paramètres

Retours

Définit la mise en page spécifiée comme valeur par défaut à la fois du document actif et de tous les nouveaux documents basés sur le modèle actif.

setAsTemplateDefault(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Alterne entre l'orientation portrait et l'orientation paysage pour les pages d'un document ou d'une section.

togglePortrait(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

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 Word.PageSetup est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.PageSetupDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.PageSetupData;

Retours

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-section-starts.yaml

await Word.run(async (context) => {
  const pageSetup: Word.PageSetup = context.document.pageSetup;
  pageSetup.load();

  const sections: Word.SectionCollection = context.document.sections;
  sections.load("items");
  await context.sync();

  sections.items.forEach((section) => section.pageSetup.load("sectionStart"));
  await context.sync();

  console.log("Document page setup:", pageSetup.toJSON());
  sections.items.forEach((section, index) => {
    console.log(`Section ${index + 1} starts: ${section.pageSetup.sectionStart}`);
  });
});

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 entre 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 devez ajouter l’objet à la collection d’objets suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.PageSetup;

Retours

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de 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 mémoire prenne effet.

untrack(): Word.PageSetup;

Retours