Partager via


Word.PageSetup class

Représente les paramètres de mise en page d’un document ou d’une section Word.

Extends

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Propriétés

bookFoldPrinting

Spécifie si Microsoft Word imprime le document sous forme de livret.

bookFoldPrintingSheets

Spécifie le nombre de pages pour chaque livret.

bookFoldReversePrinting

Spécifie si Microsoft Word inverse l’ordre d’impression pour l’impression de plis de livres de documents bidirectionnels ou en langue asiatique.

bottomMargin

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

charsLine

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

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

differentFirstPageHeaderFooter

Spécifie si la première page a un en-tête et un pied de page différents.

footerDistance

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

gutter

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

gutterPosition

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

gutterStyle

Spécifie si Microsoft Word utilise des gouttières pour le document actif en fonction d’une langue de droite à gauche ou de gauche à droite.

headerDistance

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

layoutMode

Spécifie le mode de disposition du document actif.

leftMargin

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

lineNumbering

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

linesPage

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

mirrorMargins

Spécifie si les marges intérieure et extérieure des pages exposées ont la même largeur.

oddAndEvenPagesHeaderFooter

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

orientation

Spécifie l’orientation de la page.

pageHeight

Spécifie la hauteur de la page en points.

pageWidth

Spécifie la largeur de page en points.

paperSize

Spécifie le format de papier de la page.

rightMargin

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

sectionDirection

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

sectionStart

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

showGrid

Spécifie s’il faut afficher la grille.

suppressEndnotes

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

textColumns

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

topMargin

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

twoPagesOnOne

Spécifie s’il faut imprimer deux pages par feuille.

verticalAlignment

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

Méthodes

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(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(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.

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.

setAsTemplateDefault()

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.

togglePortrait()

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

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

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

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 mise en production de la mémoire ne prenne effet.

Détails de la propriété

bookFoldPrinting

Spécifie si Microsoft Word imprime le document sous forme de livret.

bookFoldPrinting: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

bookFoldPrintingSheets

Spécifie le nombre de pages pour chaque livret.

bookFoldPrintingSheets: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

bookFoldReversePrinting

Spécifie si Microsoft Word inverse l’ordre d’impression pour l’impression de plis de livres de documents bidirectionnels ou en langue asiatique.

bookFoldReversePrinting: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

bottomMargin

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é

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

charsLine

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

charsLine: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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é

differentFirstPageHeaderFooter

Spécifie si la première page a un en-tête et un pied de page différents.

differentFirstPageHeaderFooter: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

footerDistance

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

footerDistance: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

gutter

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

gutter: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

gutterPosition

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

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

Valeur de propriété

Word.GutterPosition | "Left" | "Right" | "Top"

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

gutterStyle

Spécifie si Microsoft Word utilise des gouttières pour le document actif en fonction d’une langue de droite à gauche ou de gauche à droite.

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

Valeur de propriété

Word.GutterStyle | "Bidirectional" | "Latin"

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

headerDistance

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

headerDistance: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

layoutMode

Spécifie le mode de disposition du document actif.

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

Valeur de propriété

Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

leftMargin

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é

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

lineNumbering

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

[ Ensemble d’API : WordApiDesktop 1.3 ]

linesPage

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

linesPage: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

mirrorMargins

Spécifie si les marges intérieure et extérieure des pages exposées ont la même largeur.

mirrorMargins: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

oddAndEvenPagesHeaderFooter

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

oddAndEvenPagesHeaderFooter: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

orientation

Spécifie l’orientation de la page.

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

Valeur de propriété

Word.PageOrientation | "Portrait" | "Landscape"

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

pageHeight

Spécifie la hauteur de la page en points.

pageHeight: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

pageWidth

Spécifie la largeur de page en points.

pageWidth: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

paperSize

Spécifie le format de 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é

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"

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

rightMargin

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é

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

sectionDirection

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

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

Valeur de propriété

Word.SectionDirection | "RightToLeft" | "LeftToRight"

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

sectionStart

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

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

Valeur de propriété

Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

showGrid

Spécifie s’il faut afficher la grille.

showGrid: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

suppressEndnotes

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é

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

textColumns

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

readonly textColumns: Word.TextColumnCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

topMargin

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

topMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

twoPagesOnOne

Spécifie s’il faut imprimer deux pages par feuille.

twoPagesOnOne: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

verticalAlignment

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é

Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Détails de la méthode

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

Paramètres

options
Word.Interfaces.PageSetupLoadOptions

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

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

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

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.PageSetupUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Word.Interfaces.PageSetupUpdateData

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

Paramètres

properties
Word.PageSetup

Retours

void

setAsTemplateDefault()

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

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

togglePortrait()

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

togglePortrait(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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

toJSON(): Word.Interfaces.PageSetupData;

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

track(): Word.PageSetup;

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 mise en production de la mémoire ne prenne effet.

untrack(): Word.PageSetup;

Retours