PowerPoint.Slide class
Representa una sola diapositiva de una presentación.
- Extends
Comentarios
[ Conjunto de API: PowerPointApi 1.2 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
// Reselects shapes that were saved previously.
await PowerPoint.run(async (context) => {
const slide1: PowerPoint.Slide = context.presentation.slides.getItem(savedSlideSelection[0]);
await context.sync();
slide1.setSelectedShapes(savedShapeSelection);
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. |
id | Obtiene el identificador único de la diapositiva. |
layout | Obtiene el diseño de la diapositiva. |
shapes | Devuelve una colección de formas de la diapositiva. |
slide |
Obtiene el |
tags | Devuelve una colección de etiquetas en la diapositiva. |
Métodos
delete() | Elimina la diapositiva de la presentación. No hace nada si la diapositiva no existe. |
load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
set |
Selecciona las formas especificadas. La selección de formas existente se reemplaza por la nueva selección. |
toJSON() | Invalida el método JavaScript |
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
id
Obtiene el identificador único de la diapositiva.
readonly id: string;
Valor de propiedad
string
Comentarios
layout
Obtiene el diseño de la diapositiva.
readonly layout: PowerPoint.SlideLayout;
Valor de propiedad
Comentarios
shapes
Devuelve una colección de formas de la diapositiva.
readonly shapes: PowerPoint.ShapeCollection;
Valor de propiedad
Comentarios
slideMaster
Obtiene el SlideMaster
objeto que representa el contenido predeterminado de la diapositiva.
readonly slideMaster: PowerPoint.SlideMaster;
Valor de propiedad
Comentarios
tags
Devuelve una colección de etiquetas en la diapositiva.
readonly tags: PowerPoint.TagCollection;
Valor de propiedad
Comentarios
Detalles del método
delete()
Elimina la diapositiva de la presentación. No hace nada si la diapositiva no existe.
delete(): void;
Devoluciones
void
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
// Deletes the selected slides.
await PowerPoint.run(async (context) => {
context.presentation.load("slides");
await context.sync();
const slides: PowerPoint.SlideScopedCollection = context.presentation.getSelectedSlides();
const slideCount = slides.getCount();
slides.load("items");
await context.sync();
slides.items.map((slide) => {
slide.delete();
});
});
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.SlideLoadOptions): PowerPoint.Slide;
Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
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.Slide;
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
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?: {
select?: string;
expand?: string;
}): PowerPoint.Slide;
Parámetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
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
setSelectedShapes(shapeIds)
Selecciona las formas especificadas. La selección de formas existente se reemplaza por la nueva selección.
setSelectedShapes(shapeIds: string[]): void;
Parámetros
- shapeIds
-
string[]
Lista de identificadores de forma que se van a seleccionar en la diapositiva. Si la lista está vacía, se borra la selección.
Devoluciones
void
Comentarios
[ Conjunto de API: PowerPointApi 1.5 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
// Reselects shapes that were saved previously.
await PowerPoint.run(async (context) => {
const slide1: PowerPoint.Slide = context.presentation.slides.getItem(savedSlideSelection[0]);
await context.sync();
slide1.setSelectedShapes(savedShapeSelection);
await context.sync();
});
...
// Selects the first two shapes on slide 1.
await PowerPoint.run(async (context) => {
context.presentation.load("slides");
await context.sync();
const slide1 = context.presentation.slides.getItemAt(0);
slide1.load("shapes");
await context.sync();
const shapes: PowerPoint.ShapeCollection = slide1.shapes;
const shape1: PowerPoint.Shape = shapes.getItemAt(0);
const shape2: PowerPoint.Shape = shapes.getItemAt(1);
shape1.load("id");
shape2.load("id");
await context.sync();
slide1.setSelectedShapes([shape1.id, shape2.id]);
await context.sync();
});
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.stringify
a su vez, llama al toJSON
método del objeto que se le pasa). Mientras que el objeto original PowerPoint.Slide
es un objeto de API, el toJSON
método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.SlideData
) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): PowerPoint.Interfaces.SlideData;