Compartir a través de

PowerPoint.SlideCollection class

  • Referencia
Paquete:
powerpoint

Representa la colección de diapositivas de la presentación.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: PowerPointApi 1.2 ]

Ejemplos

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

const chosenMaster = $("#master-id").val() as string;
const chosenLayout = $("#layout-id").val() as string;

await PowerPoint.run(async function(context) {
  // Create a new slide using an existing master slide and layout.
  const newSlideOptions: PowerPoint.AddSlideOptions = {
    slideMasterId: chosenMaster, /* An ID from `Presentation.slideMasters`. */
    layoutId: chosenLayout /* An ID from `SlideMaster.layouts`. */
  };
  context.presentation.slides.add(newSlideOptions);
  await context.sync();
});

Propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
items

Obtiene los elementos secundarios cargados en esta colección.

Métodos

add(options)

Agrega una nueva diapositiva al final de la colección.
getCount()

Obtiene el número de diapositivas de la colección.
getItem(key)

Obtiene una diapositiva con su identificador único.
getItemAt(index)

Obtiene una diapositiva mediante su índice de base cero en la colección. Las diapositivas se almacenan en el mismo orden que se muestran en la presentación.
getItemOrNullObject(id)

Obtiene una diapositiva con su identificador único. Si tal diapositiva no existe, se devuelve un objeto con una isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *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()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original PowerPoint.SlideCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.SlideCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

Detalles de las propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al 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.Slide[];

Valor de propiedad

PowerPoint.Slide[]

Detalles del método

add(options)

Agrega una nueva diapositiva al final de la colección.

add(options?: PowerPoint.AddSlideOptions): void;

Parámetros

options
PowerPoint.AddSlideOptions

Opciones que definen el tema de la nueva diapositiva.

Devoluciones

void

Comentarios

[ Conjunto de API: PowerPointApi 1.3 ]

Ejemplos

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

const chosenMaster = $("#master-id").val() as string;
const chosenLayout = $("#layout-id").val() as string;

await PowerPoint.run(async function(context) {
  // Create a new slide using an existing master slide and layout.
  const newSlideOptions: PowerPoint.AddSlideOptions = {
    slideMasterId: chosenMaster, /* An ID from `Presentation.slideMasters`. */
    layoutId: chosenLayout /* An ID from `SlideMaster.layouts`. */
  };
  context.presentation.slides.add(newSlideOptions);
  await context.sync();
});

getCount()

Obtiene el número de diapositivas de la colección.

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

OfficeExtension.ClientResult<number>

Número de diapositivas de la colección.

Comentarios

[ Conjunto de API: PowerPointApi 1.2 ]

getItem(key)

Obtiene una diapositiva con su identificador único.

getItem(key: string): PowerPoint.Slide;

Parámetros

key

string

Identificador de la diapositiva.

Devoluciones

PowerPoint.Slide

Diapositiva con el identificador único. Si dicha diapositiva no existe, se produce un error.

Comentarios

[ Conjunto de API: PowerPointApi 1.2 ]

getItemAt(index)

Obtiene una diapositiva mediante su índice de base cero en la colección. Las diapositivas se almacenan en el mismo orden que se muestran en la presentación.

getItemAt(index: number): PowerPoint.Slide;

Parámetros

index

number

Índice de la diapositiva de la colección.

Devoluciones

PowerPoint.Slide

Diapositiva en el índice especificado. Se produce un error si el índice está fuera del intervalo.

Comentarios

[ Conjunto de API: PowerPointApi 1.2 ]

Ejemplos

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

// Selects slides 2, 4, and 5.
await PowerPoint.run(async (context) => {
  context.presentation.load("slides");
  await context.sync();
  const slide2 = context.presentation.slides.getItemAt(1);
  const slide4 = context.presentation.slides.getItemAt(3);
  const slide5 = context.presentation.slides.getItemAt(4);
  slide2.load("id");
  slide4.load("id");
  slide5.load("id");
  try {
    await context.sync();
  } catch (error) {
    console.warn("This action requires at least 5 slides in the presentation.");
    return;
  }
  await context.sync();
  context.presentation.setSelectedSlides([slide2.id, slide4.id, slide5.id]);
  await context.sync();
});

getItemOrNullObject(id)

Obtiene una diapositiva con su identificador único. Si tal diapositiva no existe, se devuelve un objeto con una isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getItemOrNullObject(id: string): PowerPoint.Slide;

Parámetros

id

string

Identificador de la diapositiva.

Devoluciones

PowerPoint.Slide

Diapositiva con el identificador único.

Comentarios

[ Conjunto de API: PowerPointApi 1.2 ]

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.SlideCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideCollection;

Parámetros

options

PowerPoint.Interfaces.SlideCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

Devoluciones

PowerPoint.SlideCollection

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

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.SlideCollection

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

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.SlideCollection

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original PowerPoint.SlideCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.SlideCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

toJSON(): PowerPoint.Interfaces.SlideCollectionData;

Devoluciones

PowerPoint.Interfaces.SlideCollectionData