PowerPoint.SlideCollection class
Representa a coleção de diapositivos na apresentação.
- Extends
Comentários
[ Conjunto de API: PowerPointApi 1.2 ]
Exemplos
// 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();
});
Propriedades
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| items | Obtém os itens filhos carregados nesta coleção. |
Métodos
| add(options) | Adiciona um novo diapositivo no final da coleção. |
| get |
Obtém o número de diapositivos na coleção. |
| get |
Obtém um diapositivo com o ID exclusivo. |
| get |
Obtém um diapositivo com o respetivo índice baseado em zero na coleção. Os diapositivos são armazenados pela mesma ordem que são apresentados na apresentação. |
| get |
Obtém um diapositivo com o ID exclusivo. Se tal diapositivo não existir, é devolvido um objeto com uma |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
context
O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
context: RequestContext;Valor da propriedade
items
Obtém os itens filhos carregados nesta coleção.
readonly items: PowerPoint.Slide[];Valor da propriedade
Detalhes do método
add(options)
Adiciona um novo diapositivo no final da coleção.
add(options?: PowerPoint.AddSlideOptions): void;Parâmetros
- options
- PowerPoint.AddSlideOptions
As opções que definem o tema do novo diapositivo.
Retornos
void
Comentários
[ Conjunto de API: PowerPointApi 1.3 ]
Exemplos
// 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()
Obtém o número de diapositivos na coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
O número de diapositivos na coleção.
Comentários
getItem(key)
Obtém um diapositivo com o ID exclusivo.
getItem(key: string): PowerPoint.Slide;Parâmetros
- key
-
string
O ID do diapositivo.
Retornos
O diapositivo com o ID exclusivo. Se tal diapositivo não existir, é gerado um erro.
Comentários
getItemAt(index)
Obtém um diapositivo com o respetivo índice baseado em zero na coleção. Os diapositivos são armazenados pela mesma ordem que são apresentados na apresentação.
getItemAt(index: number): PowerPoint.Slide;Parâmetros
- index
-
number
O índice do diapositivo na coleção.
Retornos
O diapositivo no índice especificado. É apresentado um erro se o índice estiver fora do intervalo.
Comentários
[ Conjunto de API: PowerPointApi 1.2 ]
Exemplos
// 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)
Obtém um diapositivo com o ID exclusivo. Se tal diapositivo não existir, é devolvido um objeto com uma isNullObject propriedade definida como verdadeiro. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getItemOrNullObject(id: string): PowerPoint.Slide;Parâmetros
- id
-
string
O ID do diapositivo.
Retornos
O diapositivo com o ID exclusivo.
Comentários
load(options)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(options?: PowerPoint.Interfaces.SlideCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideCollection;Parâmetros
- options
-
PowerPoint.Interfaces.SlideCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
Fornece opções para as propriedades do objeto a carregar.
Retornos
load(propertyNames)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames?: string | string[]): PowerPoint.SlideCollection;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
load(propertyNamesAndPaths)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideCollection;Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original PowerPoint.SlideCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.SlideCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): PowerPoint.Interfaces.SlideCollectionData;