Word.TableRow class
Representa uma linha num Word documento.
- Extends
[ Conjunto de API: WordApi 1.3 ]
// 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}`);
});
cell |
Obtém a quantidade de células na linha. |
cells | Obtém células. |
context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
endnotes | Obtém a coleção de notas de fim na linha da tabela. |
fields | Obtém a coleção de objetos de campo na linha da tabela. |
font | Obtém a fonte. Use isto para obter e definir o nome, o tamanho e a cor da fonte, além de outras propriedades. |
footnotes | Obtém a coleção de notas de rodapé na linha da tabela. |
horizontal |
Especifica o alinhamento horizontal de cada célula na linha. O valor pode ser "Esquerda", "Centrado", "À Direita" ou "Justificado". |
is |
Verifica se a linha é uma linha de cabeçalho. Para definir o número de linhas de cabeçalho, utilize |
parent |
Obtém uma tabela pai. |
preferred |
Especifica a altura preferencial da linha em pontos. |
row |
Obtém o índice da linha em sua tabela pai. |
shading |
Especifica a cor do sombreado. Você pode definir a cor no formato "#RRGGBB" ou usando o nome da cor. |
values | Especifica os valores de texto na linha, como uma matriz JavaScript 2D. |
vertical |
Especifica o alinhamento vertical das células na linha. O valor pode ser "Superior", "Central" ou "Inferior". |
clear() | Limpa o conteúdo da linha. |
delete() | Exclui toda a linha. |
get |
Obtém o estilo de borda das células na linha. |
get |
Obtém o estilo de borda das células na linha. |
get |
Obtém o preenchimento de célula em pontos. |
get |
Obtém o preenchimento de célula em pontos. |
get |
Obtém a próxima linha. Gera um |
get |
Obtém a próxima linha. Se esta linha for a última, este método devolverá um objeto com a respetiva |
insert |
Insere um controlo de conteúdo na linha. |
insert |
Insere linhas usando esta linha como um modelo. Se os valores forem especificados, insere os valores para as novas linhas. |
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() | Intercala a linha numa célula. |
search(search |
Efetua uma pesquisa com as SearchOptions especificadas no âmbito da linha. Os resultados da pesquisa são uma coleção de objetos Range. |
select(selection |
Seleciona a linha e navega na interface do usuário do Word até ele. |
select(selection |
Seleciona a linha e navega na interface do usuário do Word até ele. |
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. |
set |
Define o preenchimento de célula em pontos. |
set |
Define o preenchimento de célula em pontos. |
toJSON() | Substitui o método JavaScript |
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 |
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 |
Obtém a quantidade de células na linha.
readonly cellCount: number;
Valor da propriedade
number
Comentários
Obtém células.
readonly cells: Word.TableCellCollection;
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}`);
});
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 a coleção de notas de fim na linha da tabela.
readonly endnotes: Word.NoteItemCollection;
Valor da propriedade
Comentários
Obtém a coleção de objetos de campo na linha da tabela.
readonly fields: Word.FieldCollection;
Valor da propriedade
Comentários
Obtém a fonte. Use isto para obter e definir o nome, o tamanho e a cor da fonte, além de outras propriedades.
readonly font: Word.Font;
Valor da propriedade
Comentários
Obtém a coleção de notas de rodapé na linha da tabela.
readonly footnotes: Word.NoteItemCollection;
Valor da propriedade
Comentários
Especifica o alinhamento horizontal de cada célula na linha. O valor pode ser "Esquerda", "Centrado", "À Direita" ou "Justificado".
horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
Valor da propriedade
Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"
Comentários
Verifica se a linha é uma linha de cabeçalho. Para definir o número de linhas de cabeçalho, utilize headerRowCount
no objeto Tabela.
readonly isHeader: boolean;
Valor da propriedade
boolean
Comentários
Obtém uma tabela pai.
readonly parentTable: Word.Table;
Valor da propriedade
Comentários
Especifica a altura preferencial da linha em pontos.
preferredHeight: number;
Valor da propriedade
number
Comentários
Obtém o índice da linha em sua tabela pai.
readonly rowIndex: number;
Valor da propriedade
number
Comentários
Especifica a cor do sombreado. Você pode definir a cor no formato "#RRGGBB" ou usando o nome da cor.
shadingColor: string;
Valor da propriedade
string
Comentários
Especifica os valores de texto na linha, como uma matriz JavaScript 2D.
values: string[][];
Valor da propriedade
string[][]
Comentários
Especifica o alinhamento vertical das células na linha. 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
Limpa o conteúdo da linha.
clear(): void;
Retornos
void
Comentários
Obtém o estilo de borda das células na linha.
getBorder(borderLocation: Word.BorderLocation): Word.TableBorder;
Parâmetros
- borderLocation
- Word.BorderLocation
Obrigatório. A localização do limite.
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 o estilo de borda das células na linha.
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
Comentários
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 ]
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 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 cellPaddingLocation = Word.CellPaddingLocation.bottom;
const cellPadding = firstTableRow.getCellPadding(cellPaddingLocation);
await context.sync();
console.log(
`Cell padding details about the ${cellPaddingLocation} border of the first table's first row: ${cellPadding.value} points`
);
});
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
Obtém a próxima linha. Gera um ItemNotFound
erro se esta linha for a última.
getNext(): Word.TableRow;
Retornos
Comentários
Obtém a próxima linha. Se esta linha 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.TableRow;
Retornos
Comentários
Insere um controlo de conteúdo na linha.
insertContentControl(): Word.ContentControl;
Retornos
Comentários
Insere linhas usando esta linha como um modelo. Se os valores forem especificados, insere os valores para as novas linhas.
insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection;
Parâmetros
Obrigatório. Onde as novas linhas devem ser inseridas, relativamente à linha atual. Tem de ser "Antes" ou "Depois".
- rowCount
-
number
Obrigatório. Número de linhas a adicionar
- values
-
string[][]
Opcional. Cadeias para inserir nas novas linhas, especificadas como uma matriz 2D. O número de células em cada linha não pode exceder o número de células na linha existente.
Retornos
Comentários
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.TableRowLoadOptions): Word.TableRow;
Parâmetros
Fornece opções para as propriedades do objeto a carregar.
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.TableRow;
Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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?: {
select?: string;
expand?: string;
}): Word.TableRow;
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
Intercala a linha numa célula.
merge(): Word.TableCell;
Retornos
Comentários
Efetua uma pesquisa com as SearchOptions especificadas no âmbito da linha. Os resultados da pesquisa são uma coleção de objetos Range.
search(searchText: string, searchOptions?: Word.SearchOptions | {
ignorePunct?: boolean;
ignoreSpace?: boolean;
matchCase?: boolean;
matchPrefix?: boolean;
matchSuffix?: boolean;
matchWholeWord?: boolean;
matchWildcards?: boolean;
}): Word.RangeCollection;
Parâmetros
- searchText
-
string
Obrigatório. O texto da pesquisa.
- searchOptions
-
Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }
Opcional. Opções da pesquisa.
Retornos
Comentários
Seleciona a linha e navega na interface do usuário do Word até ele.
select(selectionMode?: Word.SelectionMode): void;
Parâmetros
- selectionMode
- Word.SelectionMode
Opcional. O modo de seleção tem de ser "Selecionar", "Iniciar" ou "Terminar". 'Select' é o padrão.
Retornos
void
Comentários
Seleciona a linha e navega na interface do usuário do Word até ele.
select(selectionModeString?: "Select" | "Start" | "End"): void;
Parâmetros
- selectionModeString
-
"Select" | "Start" | "End"
Opcional. O modo de seleção tem de ser "Selecionar", "Iniciar" ou "Terminar". 'Select' é o padrão.
Retornos
void
Comentários
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.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parâmetros
- properties
- Word.Interfaces.TableRowUpdateData
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
Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
set(properties: Word.TableRow): void;
Parâmetros
- properties
- Word.TableRow
Retornos
void
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
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
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.TableRow
é um objeto de API, o toJSON
método devolve um objeto JavaScript simples (escrito como Word.Interfaces.TableRowData
) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Word.Interfaces.TableRowData;
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.TableRow;
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.TableRow;
Retornos
Comentários do Office Add-ins
O Office Add-ins é um projeto código aberto. Selecione um link para fornecer comentários: