PowerPoint.SlideBackgroundPictureOrTextureFill class

Représente les propriétés de remplissage d’image ou de texture PowerPoint.SlideBackground .

Extends

Remarques

Ensemble d’API : PowerPointApi 1.10

Utilisateur

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-set-background-fill.yaml

// Gets the picture or texture fill properties of the first selected slide's background.
await PowerPoint.run(async (context) => {
  const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
  const fill: PowerPoint.SlideBackgroundFill = slide.background.fill;
  fill.load("type");
  await context.sync();

  if (fill.type !== PowerPoint.SlideBackgroundFillType.pictureOrTexture) {
    console.warn("The slide background isn't a picture or texture fill.");
    return;
  }

  const pictureFill: PowerPoint.SlideBackgroundPictureOrTextureFill =
    slide.background.fill.getPictureOrTextureFillOrNullObject();
  pictureFill.load("transparency");
  await context.sync();

  if (pictureFill.isNullObject) {
    console.warn("The slide background isn't a picture or texture fill.");
  } else {
    console.log("Picture or texture fill:", `- transparency: ${pictureFill.transparency}`);
  }
});

Propriétés

context

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

transparency

Spécifie le pourcentage de transparence du remplissage sous la forme d’une valeur comprise entre 0,0 (opaque) et 1,0 (clair).

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.

setImage(base64EncodedImage)

Définit l’image utilisée pour le remplissage.

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

Détails de la propriété

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é

transparency

Spécifie le pourcentage de transparence du remplissage sous la forme d’une valeur comprise entre 0,0 (opaque) et 1,0 (clair).

transparency: number;

Valeur de propriété

number

Remarques

Ensemble d’API : PowerPointApi 1.10

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?: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillLoadOptions): PowerPoint.SlideBackgroundPictureOrTextureFill;

Paramètres

options
PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillLoadOptions

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[]): PowerPoint.SlideBackgroundPictureOrTextureFill;

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;
        }): PowerPoint.SlideBackgroundPictureOrTextureFill;

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

setImage(base64EncodedImage)

Définit l’image utilisée pour le remplissage.

setImage(base64EncodedImage: string): void;

Paramètres

base64EncodedImage

string

Chaîne qui est un encodage Base64 des données d’image.

Retours

void

Remarques

Ensemble d’API : PowerPointApi 1.10

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

toJSON(): PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData;

Retours