OneNote.TableRow class
Representa uma linha em uma tabela.
- Extends
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
Propriedades
| cell |
Obtém a quantidade de células na linha. |
| cells | Obtém as células na linha. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| id | Obtém a ID da linha. |
| parent |
Obtém uma tabela pai. |
| row |
Obtém o índice da linha em sua tabela pai. |
Métodos
| clear() | Limpa o conteúdo da linha. |
| insert |
Insere uma linha antes ou depois da linha atual. |
| insert |
Insere uma linha antes ou depois da linha atual. |
| 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 |
| set |
Define a cor de sombreamento de todas as células na linha. O código de cor para o qual definir as células. |
| 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 |
Detalhes da propriedade
cellCount
Obtém a quantidade de células na linha.
readonly cellCount: number;Valor da propriedade
number
Comentários
cells
Obtém as células na linha.
readonly cells: OneNote.TableCellCollection;Valor da propriedade
Comentários
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
id
Obtém a ID da linha.
readonly id: string;Valor da propriedade
string
Comentários
parentTable
Obtém uma tabela pai.
readonly parentTable: OneNote.Table;Valor da propriedade
Comentários
rowIndex
Obtém o índice da linha em sua tabela pai.
readonly rowIndex: number;Valor da propriedade
number
Comentários
Detalhes do método
clear()
Limpa o conteúdo da linha.
clear(): void;Retornos
void
Comentários
insertRowAsSibling(insertLocation, values)
Insere uma linha antes ou depois da linha atual.
insertRowAsSibling(insertLocation: OneNote.InsertLocation, values?: string[]): OneNote.TableRow;Parâmetros
- insertLocation
- OneNote.InsertLocation
Onde as novas linhas devem ser inseridas em relação à linha atual.
- values
-
string[]
Cadeias de caracteres a inserir na nova linha, especificadas como uma matriz. Não deve ter mais células do que na linha atual. Opcional.
Retornos
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
Exemplos
await OneNote.run(async (context) => {
const app = context.application;
const outline = app.getActiveOutline();
// Queue a command to load outline.paragraphs and their types.
context.load(outline, "paragraphs, paragraphs/type");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
const paragraphs = outline.paragraphs;
// For each table, get table rows.
for (let i = 0; i < paragraphs.items.length; i++) {
const paragraph = paragraphs.items[i];
if (paragraph.type == "Table") {
const table = paragraph.table;
// Queue a command to load table.rows.
context.load(table, "rows");
// Run the queued commands.
await context.sync();
const rows = table.rows;
rows.items[1].insertRowAsSibling("Before", ["cell0", "cell1"]);
await context.sync();
}
}
});
insertRowAsSibling(insertLocationString, values)
Insere uma linha antes ou depois da linha atual.
insertRowAsSibling(insertLocationString: "Before" | "After", values?: string[]): OneNote.TableRow;Parâmetros
- insertLocationString
-
"Before" | "After"
Onde as novas linhas devem ser inseridas em relação à linha atual.
- values
-
string[]
Cadeias de caracteres a inserir na nova linha, especificadas como uma matriz. Não deve ter mais células do que na linha atual. Opcional.
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?: OneNote.Interfaces.TableRowLoadOptions): OneNote.TableRow;Parâmetros
Fornece opções para as propriedades do objeto a 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[]): OneNote.TableRow;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
Exemplos
await OneNote.run(async (context) => {
const app = context.application;
const outline = app.getActiveOutline();
// Queue a command to load outline.paragraphs and their types.
context.load(outline, "paragraphs, paragraphs/type");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
const paragraphs = outline.paragraphs;
// For each table, get table rows.
for (let i = 0; i < paragraphs.items.length; i++) {
const paragraph = paragraphs.items[i];
if (paragraph.type == "Table") {
const table = paragraph.table;
// Queue a command to load table.rows.
context.load(table, "rows");
await context.sync();
const rows = table.rows;
// For each table row, log cell count and row index.
for (let i = 0; i < rows.items.length; i++) {
console.log("Row " + i + " Id: " + rows.items[i].id);
console.log("Row " + i + " Cell Count: " + rows.items[i].cellCount);
console.log("Row " + i + " Row Index: " + rows.items[i].rowIndex);
}
await context.sync();
}
}
});
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;
}): OneNote.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
setShadingColor(colorCode)
Define a cor de sombreamento de todas as células na linha. O código de cor para o qual definir as células.
setShadingColor(colorCode: string): void;Parâmetros
- colorCode
-
string
Retornos
void
Comentários
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 OneNote.TableRow é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como OneNote.Interfaces.TableRowData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): OneNote.Interfaces.TableRowData;Retornos
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.
track(): OneNote.TableRow;Retornos
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(): OneNote.TableRow;