Word.Section class

Ruft das Body Objekt des Abschnitts ab. Dies umfasst nicht die Kopfzeile, Fußzeile und andere Abschnittsmetadaten.

readonly body: Word.Body;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Beispiele

// 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}`);
});

Gibt ein BorderUniversalCollection Objekt zurück, das alle Rahmen im Abschnitt darstellt.

readonly borders: Word.BorderUniversalCollection;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

Beispiele

// 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.");
});

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Gibt ein PageSetup Objekt zurück, das dem Abschnitt zugeordnet ist.

readonly pageSetup: Word.PageSetup;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

Beispiele

// 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.");
});

Gibt an, ob der Abschnitt für Formulare geschützt ist.

protectedForForms: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

Beispiele

// 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.");
});

Ruft eine der Fußzeilen des Abschnitts ab.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.1

Beispiele

// 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();
});

Ruft eine der Fußzeilen des Abschnitts ab.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.1

Beispiele

// 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();
});

Ruft eine der Kopfzeilen des Abschnitts ab.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.1

Beispiele

// 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();
});

Ruft eine der Kopfzeilen des Abschnitts ab.

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

Parameter

Gibt zurück

Hinweise

API-Satz: WordApi 1.1

Beispiele

// 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();
});

Ruft den nächsten Abschnitt ab. Gibt einen ItemNotFound Fehler aus, wenn dieser Abschnitt der letzte ist.

getNext(): Word.Section;

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

Beispiele

// 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}`);
});

Ruft den nächsten Abschnitt ab. Wenn dieser Abschnitt der letzte ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getNextOrNullObject(): Word.Section;

Gibt zurück

Hinweise

API-Satz: WordApi 1.3

Beispiele

// 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}`);
});

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Word.Interfaces.SectionLoadOptions): Word.Section;

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Word.Section;

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Section;

Parameter

Gibt zurück

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

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

Parameter

Gibt zurück

Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Word.Section): void;

Parameter

Gibt zurück

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Word.Section Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.SectionData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Word.Interfaces.SectionData;

Gibt zurück

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt aufrufübergreifend .sync und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Sammlung ist, sollten Sie auch die übergeordnete Sammlung nachverfolgen.

track(): Word.Section;

Gibt zurück

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Word.Section;

Gibt zurück