Word.Section class

Package:: word

Représente une section d’un document Word.

Extends: OfficeExtension.ClientObject

Remarques

Utilisateur

Exemples

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

// Gets the first section and reads the text in its body.
await Word.run(async (context) => {
  const sections: Word.SectionCollection = context.document.sections;
  const firstSection: Word.Section = sections.getFirst();
  const firstSectionBody: Word.Body = firstSection.body;
  firstSectionBody.load("text");

  await context.sync();

  console.log(`First section text: ${firstSectionBody.text}`);
});

Propriétés

body	Récupère l’objet `Body` de la section. Cela n’inclut pas l’en-tête, le pied de page et les autres métadonnées de section.
borders	Renvoie un `BorderUniversalCollection` objet qui représente toutes les bordures de la section.
context	Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
pageSetup	Renvoie un `PageSetup` objet associé à la section.
protectedForForms	Indique si la section est protégée pour les formulaires.

Méthodes

getFooter(type)	Obtient l’un des pieds de page de la section.
getFooter(type)	Obtient l’un des pieds de page de la section.
getHeader(type)	Obtient l’un des en-têtes de la section.
getHeader(type)	Obtient l’un des en-têtes de la section.
getNext()	Obtient la section suivante. Génère une `ItemNotFound` erreur si cette section est la dernière.
getNextOrNullObject()	Obtient la section suivante. Si cette section est la dernière, cette méthode renvoie un objet dont la `isNullObject` propriété est définie sur `true`. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
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 transmettre soit un objet ordinaire avec les propriétés appropriées, soit 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 `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.Section` est un objet API, la `toJSON` méthode renvoie un objet JavaScript simple (typé ) `Word.Interfaces.SectionData`qui contient des copies superficielles de toutes les propriétés enfants chargées à partir 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 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.
untrack()	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.

Détails de la propriété

body

Récupère l’objet Body de la section. Cela n’inclut pas l’en-tête, le pied de page et les autres métadonnées de section.

readonly body: Word.Body;

Valeur de propriété

Word.Body

Remarques

Jeu d’API : WordApi 1.1

Exemples

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

// Gets the body of the second section and reads its text.
await Word.run(async (context) => {
  const sections: Word.SectionCollection = context.document.sections;
  sections.load("items");
  await context.sync();

  const secondSection: Word.Section = sections.items[1];
  const secondSectionBody: Word.Body = secondSection.body;
  secondSectionBody.load("text");

  await context.sync();

  console.log(`Second section text: ${secondSectionBody.text}`);
});

borders

Renvoie un BorderUniversalCollection objet qui représente toutes les bordures de la section.

readonly borders: Word.BorderUniversalCollection;

Valeur de propriété

Word.BorderUniversalCollection

Remarques

Jeu d’API : WordApiDesktop 1.3

Exemples

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

// Applies a double blue page border to every section in the report.
await Word.run(async (context) => {
  const sections: Word.SectionCollection = context.document.sections;
  const firstSection: Word.Section = sections.getFirst();
  const sectionBorders: Word.BorderUniversalCollection = firstSection.borders;
  sectionBorders.load("items");
  await context.sync();

  sectionBorders.items.forEach((sectionBorder: Word.BorderUniversal) => {
    sectionBorder.isVisible = true;
    sectionBorder.color = "#4472C4";
    sectionBorder.lineStyle = Word.BorderLineStyle.double;
    sectionBorder.lineWidth = Word.LineWidth.pt150;
  });
  sectionBorders.applyPageBordersToAllSections();

  await context.sync();
  console.log("Applied page borders to every section.");
});

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é

Word.RequestContext

pageSetup

Renvoie un PageSetup objet associé à la section.

readonly pageSetup: Word.PageSetup;

Valeur de propriété

Word.PageSetup

Remarques

Jeu d’API : WordApiDesktop 1.3

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) => {

  // Configure document-wide page settings for a report that will be printed and bound.
  const pageSetup: Word.PageSetup = context.document.pageSetup;
  pageSetup.set({
    paperSize: Word.PaperSize.letter,
    orientation: Word.PageOrientation.portrait,
    topMargin: 72,
    bottomMargin: 72,
    leftMargin: 90,
    rightMargin: 72,
    gutter: 18,
    gutterPosition: Word.GutterPosition.left,
    mirrorMargins: true,
    oddAndEvenPagesHeaderFooter: true
  });

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

  // Start the main chapter on an odd-numbered page so it appears on the right in a bound document.
  const chapterPageSetup: Word.PageSetup = sections.items[1].pageSetup;
  chapterPageSetup.sectionStart = Word.SectionStart.oddPage;
  chapterPageSetup.differentFirstPageHeaderFooter = true;

  // Keep the appendix in a separate section, but let it begin on the current page.
  sections.items[2].pageSetup.sectionStart = Word.SectionStart.continuous;

  await context.sync();
  console.log("Applied print and binding settings to the report.");
});

protectedForForms

Indique si la section est protégée pour les formulaires.

protectedForForms: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : WordApiDesktop 1.3

Exemples

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

// Protects the main chapter section when document form protection is enabled.
await Word.run(async (context) => {
  const sections: Word.SectionCollection = context.document.sections;
  sections.load("items");
  await context.sync();

  const chapterSection: Word.Section = sections.items[1];
  chapterSection.protectedForForms = true;

  await context.sync();
  console.log("Marked the main chapter section for form protection.");
});

Détails de la méthode

getFooter(type)

Obtient l’un des pieds de page de la section.

getFooter(type: Word.HeaderFooterType): Word.Body;

Paramètres

type: Word.HeaderFooterType

Type de pied de page à renvoyer. Cette valeur doit être : primary, firstPage, ou evenPages.

Retours

Word.Body

Remarques

Jeu d’API : WordApi 1.1

Exemples

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy sectionsCollection object.
    const mySections = context.document.sections;
    
    // Queue a command to load the sections.
    mySections.load('body/style');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
        
    // Create a proxy object the primary footer of the first section.
    // Note that the footer is a body object.
    const myFooter = mySections.items[0].getFooter(Word.HeaderFooterType.primary);
    
    // Queue a command to insert text at the end of the footer.
    myFooter.insertText("This is a footer.", Word.InsertLocation.end);
    
    // Queue a command to wrap the header in a content control.
    myFooter.insertContentControl();
                            
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    console.log("Added a footer to the first section.");   
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-header-and-footer.yaml

// Inserts a first-page footer by using the HeaderFooterType enum.
await Word.run(async (context) => {
  const sections: Word.SectionCollection = context.document.sections;
  const firstSection: Word.Section = sections.getFirst();
  const footerType: Word.HeaderFooterType = Word.HeaderFooterType.firstPage;
  const firstPageFooter: Word.Body = firstSection.getFooter(footerType);
  firstPageFooter.insertParagraph("This is a first-page footer.", Word.InsertLocation.end);

  await context.sync();
});

getFooter(type)

Obtient l’un des pieds de page de la section.

getFooter(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body;

Paramètres

type: "Primary" | "FirstPage" | "EvenPages"

Type de pied de page à renvoyer. Cette valeur doit être : primary, firstPage, ou evenPages.

Retours

Word.Body

Remarques

Jeu d’API : WordApi 1.1

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-header-and-footer.yaml

// Inserts a primary footer by using the string overload.
await Word.run(async (context) => {
  const sections: Word.SectionCollection = context.document.sections;
  const firstSection: Word.Section = sections.getFirst();
  const primaryFooter: Word.Body = firstSection.getFooter("Primary");
  primaryFooter.insertParagraph("This is a primary footer.", Word.InsertLocation.end);

  await context.sync();
});

getHeader(type)

Obtient l’un des en-têtes de la section.

getHeader(type: Word.HeaderFooterType): Word.Body;

Paramètres

type: Word.HeaderFooterType

Type d’en-tête à retourner. Cette valeur doit être : primary, firstPage, ou evenPages.

Retours

Word.Body

Remarques

Jeu d’API : WordApi 1.1

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-header-and-footer.yaml

// Inserts a primary header by using the HeaderFooterType enum.
await Word.run(async (context) => {
  const sections: Word.SectionCollection = context.document.sections;
  const firstSection: Word.Section = sections.getFirst();
  const headerType: Word.HeaderFooterType = Word.HeaderFooterType.primary;
  const primaryHeader: Word.Body = firstSection.getHeader(headerType);
  primaryHeader.insertParagraph("This is a primary header.", Word.InsertLocation.end);

  await context.sync();
});

getHeader(type)

Obtient l’un des en-têtes de la section.

getHeader(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body;

Paramètres

type: "Primary" | "FirstPage" | "EvenPages"

Type d’en-tête à retourner. Cette valeur doit être : primary, firstPage, ou evenPages.

Retours

Word.Body

Remarques

Jeu d’API : WordApi 1.1

Exemples

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy sectionsCollection object.
    const mySections = context.document.sections;
    
    // Queue a command to load the sections.
    mySections.load('body/style');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    
    // Create a proxy object the primary header of the first section.
    // Note that the header is a body object.
    const myHeader = mySections.items[0].getHeader("Primary");
    
    // Queue a command to insert text at the end of the header.
    myHeader.insertText("This is a header.", Word.InsertLocation.end);
    
    // Queue a command to wrap the header in a content control.
    myHeader.insertContentControl();
                            
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    console.log("Added a header to the first section.");
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-header-and-footer.yaml

// Inserts a first-page header by using the string overload.
await Word.run(async (context) => {
  const sections: Word.SectionCollection = context.document.sections;
  const firstSection: Word.Section = sections.getFirst();
  const firstPageHeader: Word.Body = firstSection.getHeader("FirstPage");
  firstPageHeader.insertParagraph("This is a first-page header.", Word.InsertLocation.end);

  await context.sync();
});

getNext()

Obtient la section suivante. Génère une ItemNotFound erreur si cette section est la dernière.

getNext(): Word.Section;

Retours

Word.Section

Remarques

Jeu d’API : WordApi 1.3

Exemples

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

// Gets the section after the current selection when another section is expected.
await Word.run(async (context) => {
  const selection: Word.Range = context.document.getSelection();
  const selectedBody: Word.Body = selection.parentBody;
  const selectedSection: Word.Section = selectedBody.parentSection;
  const nextSection: Word.Section = selectedSection.getNext();
  const nextSectionBody: Word.Body = nextSection.body;
  nextSectionBody.load("text");

  await context.sync();

  console.log(`Next section text: ${nextSectionBody.text}`);
});

getNextOrNullObject()

Obtient la section suivante. Si cette section est la dernière, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getNextOrNullObject(): Word.Section;

Retours

Word.Section

Remarques

Jeu d’API : WordApi 1.3

Exemples

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

// Gets the section after the current selection, or a null object if it is the last section.
await Word.run(async (context) => {
  const selection: Word.Range = context.document.getSelection();
  const selectedBody: Word.Body = selection.parentBody;
  const selectedSection: Word.Section = selectedBody.parentSection;
  const nextSection: Word.Section = selectedSection.getNextOrNullObject();
  nextSection.load("isNullObject, body/text");

  await context.sync();

  if (nextSection.isNullObject) {
    console.log("The document doesn't have another section.");
    return;
  }

  console.log(`Next section text: ${nextSection.body.text}`);
});

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.SectionLoadOptions): Word.Section;

Paramètres

options: Word.Interfaces.SectionLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Word.Section

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.Section;

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

Word.Section

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.Section;

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

Word.Section

set(properties, options)

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

Paramètres

properties: Word.Interfaces.SectionUpdateData

Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux 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 de propriétés 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.Section): void;

Paramètres

properties: Word.Section

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, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.Section est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.SectionDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.SectionData;

Retours

Word.Interfaces.SectionData

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 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.Section;

Retours

Word.Section

untrack()

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.Section;

Retours

Word.Section

Commentaires

Cette page a-t-elle été utile ?