Objet Section (interface API JavaScript pour Word)

Office and SharePoint Add-ins

La dernière version de ce complément Office est disponible dans le référentiel GitHub des compléments.


Représente une section d’un document Word.

S’applique à : Word 2016, Word pour iPad, Word pour Mac

Aucun

RelationTypeDescription
bodyBodyObtient le corps de la section. L’en-tête/le pied de page et les autres métadonnées de section ne sont pas inclus. En lecture seule.
MéthodeType renvoyéDescription
getFooter(type: HeaderFooterType)BodyObtient l’un des pieds de page de la section.
getHeader(type: HeaderFooterType)BodyObtient l’un des en-têtes de la section.
load(param: object)voidRemplit l’objet proxy créé dans le calque JavaScript avec des valeurs de propriété et d’objet spécifiées dans le paramètre.

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

Syntaxe

jssectionObject.getFooter(type);

Paramètres

ParamètreTypeDescription
typeHeaderFooterTypeObligatoire. Type de pied de page à renvoyer. Cette valeur peut être : « primary » (primaire), « firstPage » (première page) ou « evenPages » (pages paires).

Retourne

Body

Exemples


// Run a batch operation against the Word object model.
Word.run(function (context) {
    
    // Create a proxy sectionsCollection object.
    var mySections = context.document.sections;
    
    // Queue a commmand to load the sections.
    context.load(mySections, 'body/style');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    return context.sync().then(function () {
        
        // Create a proxy object the primary footer of the first section. 
        // Note that the footer is a body object.
        var myFooter = mySections.items[0].getFooter("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.
        return context.sync().then(function () {
            console.log("Added a footer to the first section.");
        });                    
    });  
})
.catch(function (error) {
    console.log('Error: ' + JSON.stringify(error));
    if (error instanceof OfficeExtension.Error) {
        console.log('Debug info: ' + JSON.stringify(error.debugInfo));
    }
});

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

Syntaxe

jssectionObject.getHeader(type);

Paramètres

ParamètreTypeDescription
typeHeaderFooterTypeObligatoire. Type d’en-tête à retourner. Cette valeur peut être : « primary » (primaire), « firstPage » (première page) ou « evenPages » (pages paires).

Retourne

Body

Exemples


// Run a batch operation against the Word object model.
Word.run(function (context) {
    
    // Create a proxy sectionsCollection object.
    var mySections = context.document.sections;
    
    // Queue a commmand to load the sections.
    context.load(mySections, 'body/style');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    return context.sync().then(function () {
        
        // Create a proxy object the primary header of the first section. 
        // Note that the header is a body object.
        var 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.
        return context.sync().then(function () {
            console.log("Added a header to the first section.");
        });                    
    });  
})
.catch(function (error) {
    console.log('Error: ' + JSON.stringify(error));
    if (error instanceof OfficeExtension.Error) {
        console.log('Debug info: ' + JSON.stringify(error.debugInfo));
    }
});

Remplit l’objet proxy créé dans le calque JavaScript avec des valeurs de propriété et d’objet spécifiées dans le paramètre.

Syntaxe

jsobject.load(param);

Paramètres

ParamètreTypeDescription
paramobjectFacultatif. Accepte les noms de paramètre et de relation sous forme de chaîne délimitée ou de tableau. Sinon, indiquez l’objet loadOption.

Retourne

void

Utilisez l’ensemble de conditions requises dans les vérifications à l’exécution pour vous assurer que votre application est prise en charge par la version d’hôte de Word. Pour plus d’informations sur la configuration requise pour le serveur et l’application d’hôte Office, voir Configuration requise pour exécuter des compléments Office.

Afficher: