Word.TableRowCollection class

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

Obtém os itens filhos carregados nesta coleção.

readonly items: Word.TableRow[];

Valor da propriedade

Converte linhas numa tabela em texto.

convertToText(options?: Word.TableConvertToTextOptions): Word.Range;

Parâmetros

Retornos

Um Range objeto que representa o texto convertido.

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Elimina as linhas da tabela.

delete(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Ajusta a altura das linhas para que sejam iguais.

distributeHeight(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém a primeira linha nesta coleção. Gera um ItemNotFound erro se esta coleção estiver vazia.

getFirst(): Word.TableRow;

Retornos

Comentários

[ Conjunto de API: WordApi 1.3 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml

// Gets border details about the first row of the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const firstTableRow: Word.TableRow = firstTable.rows.getFirst();
  const borderLocation = Word.BorderLocation.bottom;
  const border: Word.TableBorder = firstTableRow.getBorder(borderLocation);
  border.load(["type", "color", "width"]);
  await context.sync();

  console.log(`Details about the ${borderLocation} border of the first table's first row:`, `- Color: ${border.color}`, `- Type: ${border.type}`, `- Width: ${border.width} points`);
});

Obtém a primeira linha nesta coleção. Se esta coleção estiver vazia, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

getFirstOrNullObject(): Word.TableRow;

Retornos

Comentários

[ Conjunto de API: WordApi 1.3 ]

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: Word.Interfaces.TableRowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableRowCollection;

Parâmetros

Retornos

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[]): Word.TableRowCollection;

Parâmetros

Retornos

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): Word.TableRowCollection;

Parâmetros

Retornos

Seleciona as linhas da tabela.

select(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Define a altura das células numa tabela.

setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Define a altura das células numa tabela.

setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Define o avanço esquerdo para a linha da tabela.

setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Define o avanço esquerdo para a linha da tabela.

setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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 Word.TableRowCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.TableRowCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): Word.Interfaces.TableRowCollectionData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.

track(): Word.TableRowCollection;

Retornos

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

untrack(): Word.TableRowCollection;

Retornos