PowerPoint.Shape class
Representa uma única forma no slide.
- Extends
Comentários
[ Conjunto de API: PowerPointApi 1.3 ]
Propriedades
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| fill | Retorna a formatação de preenchimento dessa forma. |
| height | Especifica a altura, em pontos, da forma. Gera uma exceção |
| id | Obtém a ID exclusiva da forma. |
| left | A distância, em pontos, do lado esquerdo da forma para o lado esquerdo do slide. |
| line |
Retorna a formatação de linha do objeto de forma. |
| name | Especifica o nome dessa forma. |
| tags | Retorna uma coleção de marcas na forma. |
| text |
Retorna o objeto text frame de uma forma. |
| top | A distância, em pontos, da borda superior da forma até a borda superior do slide. |
| type | Retorna o tipo dessa forma. Consulte PowerPoint.ShapeType para obter detalhes. |
| width | Especifica a largura, em pontos, da forma. Gera uma exceção |
Métodos
| delete() | Exclui a forma da coleção de formas. Não fará nada se a forma não existir. |
| get |
Retorna o objeto pai do PowerPoint.Slide que contém este |
| get |
Retorna o objeto pai PowerPoint.SlideLayout que contém este |
| get |
Retorna o objeto pai PowerPoint.SlideLayout que contém este |
| get |
Retorna o objeto pai do PowerPoint.SlideMaster que contém este |
| get |
Retorna o objeto pai do PowerPoint.SlideMaster que contém este |
| get |
Retorna o objeto pai do PowerPoint.Slide que contém este |
| 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 de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;Valor da propriedade
fill
Retorna a formatação de preenchimento dessa forma.
readonly fill: PowerPoint.ShapeFill;Valor da propriedade
Comentários
[ Conjunto de API: PowerPointApi 1.4 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
// Changes the selected shapes fill color to red.
await PowerPoint.run(async (context) => {
const shapes = context.presentation.getSelectedShapes();
const shapeCount = shapes.getCount();
shapes.load("items");
await context.sync();
shapes.items.map((shape) => {
shape.fill.setSolidColor("red");
});
await context.sync();
});
height
Especifica a altura, em pontos, da forma. Gera uma exceção InvalidArgument quando definida com um valor negativo.
height: number;Valor da propriedade
number
Comentários
[ Conjunto de API: PowerPointApi 1.4 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
const shapes = context.presentation.getSelectedShapes();
const shapeCount = shapes.getCount();
shapes.load("items");
await context.sync();
let maxHeight = 0;
shapes.items.map((shape) => {
shape.load("width,height");
});
await context.sync();
shapes.items.map((shape) => {
shape.left = currentLeft;
shape.top = currentTop;
currentLeft += shape.width;
if (shape.height > maxHeight) maxHeight = shape.height;
});
await context.sync();
currentLeft = 0;
if (currentTop > slideHeight - 200) currentTop = 0;
});
id
Obtém a ID exclusiva da forma.
readonly id: string;Valor da propriedade
string
Comentários
left
A distância, em pontos, do lado esquerdo da forma para o lado esquerdo do slide.
left: number;Valor da propriedade
number
Comentários
[ Conjunto de API: PowerPointApi 1.4 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
const shapes = context.presentation.getSelectedShapes();
const shapeCount = shapes.getCount();
shapes.load("items");
await context.sync();
let maxHeight = 0;
shapes.items.map((shape) => {
shape.load("width,height");
});
await context.sync();
shapes.items.map((shape) => {
shape.left = currentLeft;
shape.top = currentTop;
currentLeft += shape.width;
if (shape.height > maxHeight) maxHeight = shape.height;
});
await context.sync();
currentLeft = 0;
if (currentTop > slideHeight - 200) currentTop = 0;
});
lineFormat
Retorna a formatação de linha do objeto de forma.
readonly lineFormat: PowerPoint.ShapeLineFormat;Valor da propriedade
Comentários
name
Especifica o nome dessa forma.
name: string;Valor da propriedade
string
Comentários
tags
Retorna uma coleção de marcas na forma.
readonly tags: PowerPoint.TagCollection;Valor da propriedade
Comentários
textFrame
Retorna o objeto text frame de uma forma.
readonly textFrame: PowerPoint.TextFrame;Valor da propriedade
Comentários
top
A distância, em pontos, da borda superior da forma até a borda superior do slide.
top: number;Valor da propriedade
number
Comentários
[ Conjunto de API: PowerPointApi 1.4 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
const shapes = context.presentation.getSelectedShapes();
const shapeCount = shapes.getCount();
shapes.load("items");
await context.sync();
let maxHeight = 0;
shapes.items.map((shape) => {
shape.load("width,height");
});
await context.sync();
shapes.items.map((shape) => {
shape.left = currentLeft;
shape.top = currentTop;
currentLeft += shape.width;
if (shape.height > maxHeight) maxHeight = shape.height;
});
await context.sync();
currentLeft = 0;
if (currentTop > slideHeight - 200) currentTop = 0;
});
type
Retorna o tipo dessa forma. Consulte PowerPoint.ShapeType para obter detalhes.
readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table";Valor da propriedade
PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table"
Comentários
width
Especifica a largura, em pontos, da forma. Gera uma exceção InvalidArgument quando definida com um valor negativo.
width: number;Valor da propriedade
number
Comentários
[ Conjunto de API: PowerPointApi 1.4 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
const shapes = context.presentation.getSelectedShapes();
const shapeCount = shapes.getCount();
shapes.load("items");
await context.sync();
let maxHeight = 0;
shapes.items.map((shape) => {
shape.load("width,height");
});
await context.sync();
shapes.items.map((shape) => {
shape.left = currentLeft;
shape.top = currentTop;
currentLeft += shape.width;
if (shape.height > maxHeight) maxHeight = shape.height;
});
await context.sync();
currentLeft = 0;
if (currentTop > slideHeight - 200) currentTop = 0;
});
Detalhes do método
delete()
Exclui a forma da coleção de formas. Não fará nada se a forma não existir.
delete(): void;Retornos
void
Comentários
getParentSlide()
Retorna o objeto pai do PowerPoint.Slide que contém este Shape. Gera uma exceção se essa forma não pertencer a um Slide.
getParentSlide(): PowerPoint.Slide;Retornos
Comentários
getParentSlideLayout()
Retorna o objeto pai PowerPoint.SlideLayout que contém este Shape. Gera uma exceção se essa forma não pertencer a um SlideLayout.
getParentSlideLayout(): PowerPoint.SlideLayout;Retornos
Comentários
getParentSlideLayoutOrNullObject()
Retorna o objeto pai PowerPoint.SlideLayout que contém este Shape. Se essa forma não pertencer a um SlideLayout, um objeto com uma isNullObject propriedade definida para true é retornado.
getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout;Retornos
Comentários
getParentSlideMaster()
Retorna o objeto pai do PowerPoint.SlideMaster que contém este Shape. Gera uma exceção se essa forma não pertencer a um SlideMaster.
getParentSlideMaster(): PowerPoint.SlideMaster;Retornos
Comentários
getParentSlideMasterOrNullObject()
Retorna o objeto pai do PowerPoint.SlideMaster que contém este Shape. Se essa forma não pertencer a um SlideMaster, um objeto com uma isNullObject propriedade definida para true é retornado.
getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster;Retornos
Comentários
getParentSlideOrNullObject()
Retorna o objeto pai do PowerPoint.Slide que contém este Shape. Se essa forma não pertencer a um Slide, um objeto com uma isNullObject propriedade definida para true é retornado.
getParentSlideOrNullObject(): PowerPoint.Slide;Retornos
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.ShapeLoadOptions): PowerPoint.Shape;Parâmetros
Fornece opções para quais propriedades do objeto 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.Shape;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
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?: {
select?: string;
expand?: string;
}): PowerPoint.Shape;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto PowerPoint.Shape original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.ShapeData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): PowerPoint.Interfaces.ShapeData;Retornos
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de