Word.TableCell class

Referência

Pacote:: word

Representa uma célula de tabela num documento Word.

Extends: OfficeExtension.ClientObject

Comentários

Exemplos

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

// Gets content alignment details about the first cell 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 firstCell: Word.TableCell = firstTableRow.cells.getFirst();
  firstCell.load(["horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table's first cell:`, `- Horizontal alignment of the cell's content: ${firstCell.horizontalAlignment}`, `- Vertical alignment of the cell's content: ${firstCell.verticalAlignment}`);
});

Propriedades

body	Obtém o objeto do corpo da célula.
cellIndex	Obtém o índice da célula em sua linha.
columnWidth	Especifica a largura da coluna da célula em pontos. Isto é aplicável às tabelas uniformes.
context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
horizontalAlignment	Especifica o alinhamento horizontal da célula. O valor pode ser "Esquerda", "Centrado", "À Direita" ou "Justificado".
parentRow	Obtém a linha pai da célula.
parentTable	Obtém a tabela pai da célula.
rowIndex	Obtém o índice da linha da célula na tabela.
shadingColor	Especifica a cor de sombreado da célula. Você pode definir a cor no formato "#RRGGBB" ou usando o nome da cor.
value	Especifica o texto da célula.
verticalAlignment	Especifica o alinhamento vertical da célula. O valor pode ser "Superior", "Central" ou "Inferior".
width	Obtém a largura da célula em pontos.

Métodos

deleteColumn()	Exclui a coluna que contém essa célula. Isto é aplicável às tabelas uniformes.
deleteRow()	Exclui a linha que contém essa célula.
getBorder(borderLocation)	Obtém o estilo de borda para a borda especificada.
getBorder(borderLocationString)	Obtém o estilo de borda para a borda especificada.
getCellPadding(cellPaddingLocation)	Obtém o preenchimento de célula em pontos.
getCellPadding(cellPaddingLocationString)	Obtém o preenchimento de célula em pontos.
getNext()	Obtém a próxima célula. Gera um `ItemNotFound` erro se esta célula for a última.
getNextOrNullObject()	Obtém a próxima célula. Se esta célula for a última, 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).
insertColumns(insertLocation, columnCount, values)	Adiciona colunas à esquerda ou à direita da célula, usando a coluna da célula como um modelo. Isto é aplicável às tabelas uniformes. Os valores de cadeia de caracteres, se especificado, são definidos nas linhas recém-inseridas.
insertRows(insertLocation, rowCount, values)	Insere linhas acima ou abaixo da célula, usando a linha da célula como um modelo. Os valores de cadeia de caracteres, se especificado, são definidos nas linhas recém-inseridas.
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(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
setCellPadding(cellPaddingLocation, cellPadding)	Define o preenchimento de célula em pontos.
setCellPadding(cellPaddingLocationString, cellPadding)	Define o preenchimento de célula em pontos.
split(rowCount, columnCount)	Divide a célula no número especificado de linhas e colunas.
toJSON()	Substitui o método JavaScript `toJSON()` para fornecer uma saída mais útil quando um objeto de API é transmitido para `JSON.stringify()`. (`JSON.stringify`por sua vez, chama o `toJSON` método do objeto que lhe é transmitido.) Enquanto o objeto original `Word.TableCell` é um objeto de API, o `toJSON` método devolve um objeto JavaScript simples (escrito como `Word.Interfaces.TableCellData`) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
track()	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.
untrack()	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.

Detalhes da propriedade

body

Obtém o objeto do corpo da célula.

readonly body: Word.Body;

Valor da propriedade

Word.Body

Comentários

[ Conjunto de API: WordApi 1.3 ]

cellIndex

Obtém o índice da célula em sua linha.

readonly cellIndex: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.3 ]

columnWidth

Especifica a largura da coluna da célula em pontos. Isto é aplicável às tabelas uniformes.

columnWidth: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.3 ]

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

Word.RequestContext

horizontalAlignment

Especifica o alinhamento horizontal da célula. O valor pode ser "Esquerda", "Centrado", "À Direita" ou "Justificado".

horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

Valor da propriedade

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 content alignment details about the first cell 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 firstCell: Word.TableCell = firstTableRow.cells.getFirst();
  firstCell.load(["horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table's first cell:`, `- Horizontal alignment of the cell's content: ${firstCell.horizontalAlignment}`, `- Vertical alignment of the cell's content: ${firstCell.verticalAlignment}`);
});

parentRow

Obtém a linha pai da célula.

readonly parentRow: Word.TableRow;

Valor da propriedade

Word.TableRow

Comentários

[ Conjunto de API: WordApi 1.3 ]

parentTable

Obtém a tabela pai da célula.

readonly parentTable: Word.Table;

Valor da propriedade

Word.Table

Comentários

[ Conjunto de API: WordApi 1.3 ]

rowIndex

Obtém o índice da linha da célula na tabela.

readonly rowIndex: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.3 ]

shadingColor

Especifica a cor de sombreado da célula. Você pode definir a cor no formato "#RRGGBB" ou usando o nome da cor.

shadingColor: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.3 ]

value

Especifica o texto da célula.

value: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.3 ]

verticalAlignment

Especifica o alinhamento vertical da célula. O valor pode ser "Superior", "Central" ou "Inferior".

verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom";

Valor da propriedade

Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"

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 content alignment details about the first cell 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 firstCell: Word.TableCell = firstTableRow.cells.getFirst();
  firstCell.load(["horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table's first cell:`, `- Horizontal alignment of the cell's content: ${firstCell.horizontalAlignment}`, `- Vertical alignment of the cell's content: ${firstCell.verticalAlignment}`);
});

width

Obtém a largura da célula em pontos.

readonly width: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.3 ]

Detalhes do método

deleteColumn()

Exclui a coluna que contém essa célula. Isto é aplicável às tabelas uniformes.

deleteColumn(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.3 ]

deleteRow()

Exclui a linha que contém essa célula.

deleteRow(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.3 ]

getBorder(borderLocation)

Obtém o estilo de borda para a borda especificada.

getBorder(borderLocation: Word.BorderLocation): Word.TableBorder;

Parâmetros

borderLocation: Word.BorderLocation

Obrigatório. A localização do limite.

Retornos

Word.TableBorder

Comentários

[ Conjunto de API: WordApi 1.3 ]

getBorder(borderLocationString)

Obtém o estilo de borda para a borda especificada.

getBorder(borderLocationString: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder;

Parâmetros

borderLocationString: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"

Obrigatório. A localização do limite.

Retornos

Word.TableBorder

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 of the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const firstCell: Word.TableCell = firstTable.getCell(0, 0);
  const borderLocation = "Left";
  const border: Word.TableBorder = firstCell.getBorder(borderLocation);
  border.load(["type", "color", "width"]);
  await context.sync();

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

getCellPadding(cellPaddingLocation)

Obtém o preenchimento de célula em pontos.

getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult<number>;

Parâmetros

cellPaddingLocation: Word.CellPaddingLocation

Obrigatório. A localização do preenchimento da célula tem de ser "Superior", "Esquerda", "Inferior" ou "Direita".

Retornos

OfficeExtension.ClientResult<number>

Comentários

[ Conjunto de API: WordApi 1.3 ]

getCellPadding(cellPaddingLocationString)

Obtém o preenchimento de célula em pontos.

getCellPadding(cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;

Parâmetros

cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right"

Obrigatório. A localização do preenchimento da célula tem de ser "Superior", "Esquerda", "Inferior" ou "Direita".

Retornos

OfficeExtension.ClientResult<number>

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 cell padding details about the first cell of the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const firstCell: Word.TableCell = firstTable.getCell(0, 0);
  const cellPaddingLocation = "Left";
  const cellPadding = firstCell.getCellPadding(cellPaddingLocation);
  await context.sync();

  console.log(
    `Cell padding details about the ${cellPaddingLocation} border of the first table's first cell: ${cellPadding.value} points`
  );
});

getNext()

Obtém a próxima célula. Gera um ItemNotFound erro se esta célula for a última.

getNext(): Word.TableCell;

Retornos

Word.TableCell

Comentários

[ Conjunto de API: WordApi 1.3 ]

getNextOrNullObject()

Obtém a próxima célula. Se esta célula for a última, 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).

getNextOrNullObject(): Word.TableCell;

Retornos

Word.TableCell

Comentários

[ Conjunto de API: WordApi 1.3 ]

insertColumns(insertLocation, columnCount, values)

Adiciona colunas à esquerda ou à direita da célula, usando a coluna da célula como um modelo. Isto é aplicável às tabelas uniformes. Os valores de cadeia de caracteres, se especificado, são definidos nas linhas recém-inseridas.

insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void;

Parâmetros

insertLocation: before | after | "Before" | "After"

Obrigatório. Tem de ser "Antes" ou "Depois".

columnCount: number

Obrigatório. Número de colunas a adicionar.

values: string[][]

Matriz 2D opcional. As células serão preenchidas se as cadeias de caracteres correspondentes estiverem especificadas na matriz.

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.3 ]

insertRows(insertLocation, rowCount, values)

Insere linhas acima ou abaixo da célula, usando a linha da célula como um modelo. Os valores de cadeia de caracteres, se especificado, são definidos nas linhas recém-inseridas.

insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection;

Parâmetros

insertLocation: before | after | "Before" | "After"

Obrigatório. Tem de ser "Antes" ou "Depois".

rowCount: number

Obrigatório. Número de linhas a adicionar.

values: string[][]

Matriz 2D opcional. As células serão preenchidas se as cadeias de caracteres correspondentes estiverem especificadas na matriz.

Retornos

Word.TableRowCollection

Comentários

[ Conjunto de API: WordApi 1.3 ]

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?: Word.Interfaces.TableCellLoadOptions): Word.TableCell;

Parâmetros

options: Word.Interfaces.TableCellLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Word.TableCell

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

Parâmetros

propertyNames: string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Word.TableCell

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

Parâmetros

propertyNamesAndPaths: { select?: string; expand?: string; }

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

Word.TableCell

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.TableCellUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties: Word.Interfaces.TableCellUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options: OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Word.TableCell): void;

Parâmetros

properties: Word.TableCell

Retornos

void

setCellPadding(cellPaddingLocation, cellPadding)

Define o preenchimento de célula em pontos.

setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void;

Parâmetros

cellPaddingLocation: Word.CellPaddingLocation

Obrigatório. A localização do preenchimento da célula tem de ser "Superior", "Esquerda", "Inferior" ou "Direita".

cellPadding: number

Obrigatório. O preenchimento da célula.

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.3 ]

setCellPadding(cellPaddingLocationString, cellPadding)

Define o preenchimento de célula em pontos.

setCellPadding(cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void;

Parâmetros

cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right"

Obrigatório. A localização do preenchimento da célula tem de ser "Superior", "Esquerda", "Inferior" ou "Direita".

cellPadding: number

Obrigatório. O preenchimento da célula.

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.3 ]

split(rowCount, columnCount)

Divide a célula no número especificado de linhas e colunas.

split(rowCount: number, columnCount: number): void;

Parâmetros

rowCount: number

Obrigatório. O número de linhas para dividir. Tem de ser um divisor do número de linhas subjacentes.

columnCount: number

Obrigatório. O número de colunas para dividir.

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.4 ]

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 Word.TableCell é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.TableCellData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.TableCellData;

Retornos

Word.Interfaces.TableCellData

track()

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.TableCell;

Retornos

Word.TableCell

untrack()

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.TableCell;

Retornos

Word.TableCell

Compartilhar via

Word.TableCell class

Comentários

Exemplos

Propriedades

Métodos

Detalhes da propriedade

body

Valor da propriedade

Comentários

cellIndex

Valor da propriedade

Comentários

columnWidth

Valor da propriedade

Comentários

context

Valor da propriedade

horizontalAlignment

Valor da propriedade

Comentários

Exemplos

parentRow

Valor da propriedade

Comentários

parentTable

Valor da propriedade

Comentários

rowIndex

Valor da propriedade

Comentários

shadingColor

Valor da propriedade

Comentários

value

Valor da propriedade

Comentários

verticalAlignment

Valor da propriedade

Comentários

Exemplos

width

Valor da propriedade

Comentários

Detalhes do método

deleteColumn()

Retornos

Comentários

deleteRow()

Retornos

Comentários

getBorder(borderLocation)

Parâmetros

Retornos

Comentários

getBorder(borderLocationString)

Parâmetros

Retornos

Comentários

Exemplos

getCellPadding(cellPaddingLocation)

Parâmetros

Retornos

Comentários

getCellPadding(cellPaddingLocationString)

Parâmetros

Retornos

Comentários

Exemplos

getNext()

Retornos

Comentários

getNextOrNullObject()

Retornos

Comentários

insertColumns(insertLocation, columnCount, values)

Parâmetros

Retornos

Comentários

insertRows(insertLocation, rowCount, values)