PowerPoint.Table class
Representa uma tabela.
- Extends
Comentários
Conjunto de APIs: PowerPointApi 1.8
Usada por
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
// Updates a table's values.
await PowerPoint.run(async (context) => {
const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
// Add a table (which is a type of Shape).
const shape = shapes.addTable(4, 3);
let table = shape.getTable();
table.load();
await context.sync();
// Update values in the table.
for (let rowIndex = 0; rowIndex < table.rowCount; rowIndex++) {
for (let columnIndex = 0; columnIndex < table.columnCount; columnIndex++) {
const cell = table.getCellOrNullObject(rowIndex, columnIndex);
cell.text = generateRandomString();
}
}
await context.sync();
});
Propriedades
| column |
Obtém a quantidade de colunas na tabela. |
| columns | Obtém a coleção de colunas na tabela. |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| row |
Obtém a quantidade de linhas na tabela. |
| rows | Obtém a coleção de linhas na tabela. |
| style |
Obtém as configurações de estilo de tabela. |
| values | Obtém todos os valores na tabela. |
Métodos
| clear(options) | Limpa os valores e a formatação da tabela. |
| get |
Obtém a célula no campo especificado |
| get |
Obtém uma coleção de células que representam as áreas mescladas da tabela. |
| get |
Obtém o objeto shape da tabela. |
| 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 |
| merge |
Cria uma área mesclada começando na célula especificada por rowIndex e columnIndex. A área mesclada se estende por um número especificado de linhas e colunas. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
columnCount
Obtém a quantidade de colunas na tabela.
readonly columnCount: number;Valor da propriedade
number
Comentários
columns
Obtém a coleção de colunas na tabela.
readonly columns: PowerPoint.TableColumnCollection;Valor da propriedade
Comentários
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
rowCount
Obtém a quantidade de linhas na tabela.
readonly rowCount: number;Valor da propriedade
number
Comentários
rows
Obtém a coleção de linhas na tabela.
readonly rows: PowerPoint.TableRowCollection;Valor da propriedade
Comentários
styleSettings
Obtém as configurações de estilo de tabela.
readonly styleSettings: PowerPoint.TableStyleSettings;Valor da propriedade
Comentários
values
Obtém todos os valores na tabela.
readonly values: string[][];Valor da propriedade
string[][]
Comentários
Detalhes do método
clear(options)
Limpa os valores e a formatação da tabela.
clear(options?: PowerPoint.TableClearOptions): void;Parâmetros
- options
- PowerPoint.TableClearOptions
Fornece opções para limpar a tabela.
Retornos
void
Comentários
getCellOrNullObject(rowIndex, columnIndex)
Obtém a célula no campo especificado rowIndex e columnIndex.
getCellOrNullObject(rowIndex: number, columnIndex: number): PowerPoint.TableCell;Parâmetros
- rowIndex
-
number
O índice de linha baseado em zero da célula.
- columnIndex
-
number
O índice da coluna baseado em zero da célula.
Retornos
A célula na linha e coluna especificadas. Se a célula fizer parte de uma área mesclada e não a célula superior esquerda da área mesclada, um objeto com a isNullObject propriedade definida como true será retornado. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
Comentários
Conjunto de APIs: PowerPointApi 1.8
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
// Updates a table's values.
await PowerPoint.run(async (context) => {
const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
// Add a table (which is a type of Shape).
const shape = shapes.addTable(4, 3);
let table = shape.getTable();
table.load();
await context.sync();
// Update values in the table.
for (let rowIndex = 0; rowIndex < table.rowCount; rowIndex++) {
for (let columnIndex = 0; columnIndex < table.columnCount; columnIndex++) {
const cell = table.getCellOrNullObject(rowIndex, columnIndex);
cell.text = generateRandomString();
}
}
await context.sync();
});
getMergedAreas()
Obtém uma coleção de células que representam as áreas mescladas da tabela.
getMergedAreas(): PowerPoint.TableCellCollection;Retornos
a TableCellCollection com células que representam as áreas mescladas da tabela.
Comentários
getShape()
Obtém o objeto shape da tabela.
getShape(): PowerPoint.Shape;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.TableLoadOptions): PowerPoint.Table;Parâmetros
Fornece opções para quais propriedades do objeto devem ser carregadas.
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.Table;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica 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.Table;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.
Retornos
mergeCells(rowIndex, columnIndex, rowCount, columnCount)
Cria uma área mesclada começando na célula especificada por rowIndex e columnIndex. A área mesclada se estende por um número especificado de linhas e colunas.
mergeCells(rowIndex: number, columnIndex: number, rowCount: number, columnCount: number): void;Parâmetros
- rowIndex
-
number
O índice de linha baseado em zero da célula para iniciar a área mesclada.
- columnIndex
-
number
O índice de coluna baseado em zero da célula para iniciar a área mesclada.
- rowCount
-
number
O número de linhas a serem mescladas com a célula inicial. Deve ser maior que 0.
- columnCount
-
number
O número de colunas a serem mescladas com a célula inicial. Deve ser maior que 0.
Retornos
void
Comentários
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original PowerPoint.Table é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.TableData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
toJSON(): PowerPoint.Interfaces.TableData;