PowerPoint.SlideLayoutCollection class

Paquete:: powerpoint

Representa la colección de diseños que proporciona el patrón de diapositivas para las diapositivas.

Extends: OfficeExtension.ClientObject

Comentarios

Usada por

PowerPoint.SlideMaster: diseños

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml

await PowerPoint.run(async function(context) {
  // Load information about all the slide masters and associated layouts.
  const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
  await context.sync();

  // Log the name and ID of each slide master.
  for (let i = 0; i < slideMasters.items.length; i++) {
    console.log("Master name: " + slideMasters.items[i].name);
    console.log("Master ID: " + slideMasters.items[i].id);

    // Log the name and ID of each slide layout in the slide master.
    const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
    for (let j = 0; j < layoutsInMaster.items.length; j++) {
      console.log("    Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
    }
  }
});

Propiedades

context	El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
items	Obtiene los elementos secundarios cargados en esta colección.

Métodos

getCount()	Obtiene el número de diseños de la colección.
getItem(key)	Obtiene un diseño mediante su identificador único.
getItemAt(index)	Obtiene un diseño con su índice basado en cero en la colección.
getItemOrNullObject(id)	Obtiene un diseño mediante su identificador único. Si no existe este diseño, se devuelve un objeto con una `isNullObject` propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.
load(options)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
load(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
toJSON()	Reemplaza el método JavaScript `toJSON()` para proporcionar una salida más útil cuando se pasa un objeto API a `JSON.stringify()`. (`JSON.stringify`, a su vez, llama al `toJSON` método del objeto que se le pasa). Mientras que el objeto original `PowerPoint.SlideLayoutCollection` es un objeto API, el `toJSON` método devuelve un objeto JavaScript simple (escrito como `PowerPoint.Interfaces.SlideLayoutCollectionData`) que contiene una matriz "items" con copias superficiales de cualquier propiedad cargada de los elementos de la colección.

Detalles de las propiedades

context

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

PowerPoint.RequestContext

items

Obtiene los elementos secundarios cargados en esta colección.

readonly items: PowerPoint.SlideLayout[];

Valor de propiedad

PowerPoint.SlideLayout[]

Detalles del método

getCount()

Obtiene el número de diseños de la colección.

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

OfficeExtension.ClientResult<number>

Número de diseños de la colección.

Comentarios

Conjunto de API: PowerPointApi 1.3

getItem(key)

Obtiene un diseño mediante su identificador único.

getItem(key: string): PowerPoint.SlideLayout;

Parámetros

key: string

El Id. del diseño.

Devoluciones

PowerPoint.SlideLayout

El diseño con el identificador único. Si no existe dicho diseño, se produce un error.

Comentarios

Conjunto de API: PowerPointApi 1.3

getItemAt(index)

Obtiene un diseño con su índice basado en cero en la colección.

getItemAt(index: number): PowerPoint.SlideLayout;

Parámetros

index: number

Índice del diseño en la colección.

Devoluciones

PowerPoint.SlideLayout

El diseño en el índice dado. Se produce un error si el índice está fuera del intervalo.

Comentarios

Conjunto de API: PowerPointApi 1.3

getItemOrNullObject(id)

Obtiene un diseño mediante su identificador único. Si no existe este diseño, se devuelve un objeto con una isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.

getItemOrNullObject(id: string): PowerPoint.SlideLayout;

Parámetros

id: string

El Id. del diseño.

Devoluciones

PowerPoint.SlideLayout

El diseño con el identificador único.

Comentarios

Conjunto de API: PowerPointApi 1.3

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideLayoutCollection;

Parámetros

options: PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

PowerPoint.SlideLayoutCollection

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): PowerPoint.SlideLayoutCollection;

Parámetros

propertyNames: string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

PowerPoint.SlideLayoutCollection

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml

await PowerPoint.run(async function(context) {
  // Load information about all the slide masters and associated layouts.
  const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
  await context.sync();

  // Log the name and ID of each slide master.
  for (let i = 0; i < slideMasters.items.length; i++) {
    console.log("Master name: " + slideMasters.items[i].name);
    console.log("Master ID: " + slideMasters.items[i].id);

    // Log the name and ID of each slide layout in the slide master.
    const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
    for (let j = 0; j < layoutsInMaster.items.length; j++) {
      console.log("    Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
    }
  }
});

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideLayoutCollection;

Parámetros

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

PowerPoint.SlideLayoutCollection

toJSON()

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original PowerPoint.SlideLayoutCollection es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como PowerPoint.Interfaces.SlideLayoutCollectionData) que contiene una matriz "items" con copias superficiales de cualquier propiedad cargada de los elementos de la colección.

toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData;

Devoluciones

PowerPoint.Interfaces.SlideLayoutCollectionData

Comentarios

¿Le ha resultado útil esta página?