Compartilhar via

OneNote.Table class

  • Referência
Pacote:
onenote

Representa uma tabela em uma página do OneNote.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Propriedades

borderVisible

Obtém ou define se as bordas estão visíveis ou não. True se forem visíveis, false se forem ocultas.
columnCount

Obtém a quantidade de colunas na tabela.
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 tabela.
paragraph

Obtém o objeto Paragraph que contém o objeto Table.
rowCount

Obtém a quantidade de linhas na tabela.
rows

Obtém todas as linhas da tabela.

Métodos

appendColumn(values)

Adiciona uma coluna ao final da tabela. Valores, se especificados, são definidos na nova coluna. Caso contrário, a coluna fica vazia.
appendRow(values)

Adiciona uma linha ao final da tabela. Valores, se especificados, são definidos na nova linha. Caso contrário, a linha fica vazia.
clear()

Limpa o conteúdo da tabela.
getCell(rowIndex, cellIndex)

Obtém a célula da tabela em uma linha e coluna especificada.
insertColumn(index, values)

Insere uma coluna no índice fornecido na tabela. Valores, se especificados, são definidos na nova coluna. Caso contrário, a coluna fica vazia.
insertRow(index, values)

Insere uma linha no índice fornecido na tabela. Valores, se especificados, são definidos na nova linha. Caso contrário, a linha fica vazia.
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.
setShadingColor(colorCode)

Define a cor de sombreamento de todas as células na tabela. O código de cor para o qual definir as células.
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.Table é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como OneNote.Interfaces.TableData) 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.
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

borderVisible

Obtém ou define se as bordas estão visíveis ou não. True se forem visíveis, false se forem ocultas.

borderVisible: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

columnCount

Obtém a quantidade de colunas na tabela.

readonly columnCount: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

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

OneNote.RequestContext

id

Obtém a ID da tabela.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

paragraph

Obtém o objeto Paragraph que contém o objeto Table.

readonly paragraph: OneNote.Paragraph;

Valor da propriedade

OneNote.Paragraph

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

rowCount

Obtém a quantidade de linhas na tabela.

readonly rowCount: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

rows

Obtém todas as linhas da tabela.

readonly rows: OneNote.TableRowCollection;

Valor da propriedade

OneNote.TableRowCollection

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Detalhes do método

appendColumn(values)

Adiciona uma coluna ao final da tabela. Valores, se especificados, são definidos na nova coluna. Caso contrário, a coluna fica vazia.

appendColumn(values?: string[]): void;

Parâmetros

values

string[]

Opcional. Cadeias de caracteres a inserir na nova coluna, especificada como uma matriz. Não pode ter mais valores que linhas na tabela.

Retornos

void

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, append a column.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            table.appendColumn(["cell0", "cell1"]);
        }
    }
    await context.sync();
});

appendRow(values)

Adiciona uma linha ao final da tabela. Valores, se especificados, são definidos na nova linha. Caso contrário, a linha fica vazia.

appendRow(values?: string[]): OneNote.TableRow;

Parâmetros

values

string[]

Opcional. Cadeias de caracteres a inserir na nova linha, especificadas como uma matriz. Não pode ter mais valores que colunas na tabela.

Retornos

OneNote.TableRow

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, append a column.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            const row = table.appendRow(["cell0", "cell1"]);
        }
    }
    await context.sync();
});

clear()

Limpa o conteúdo da tabela.

clear(): void;

Retornos

void

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

getCell(rowIndex, cellIndex)

Obtém a célula da tabela em uma linha e coluna especificada.

getCell(rowIndex: number, cellIndex: number): OneNote.TableCell;

Parâmetros

rowIndex

number

O índice da linha.

cellIndex

number

O índice da célula na linha.

Retornos

OneNote.TableCell

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 a cell in the second row and third column.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            const cell = table.getCell(2 /*Row Index*/, 3 /*Column Index*/);
        }
    }
    await context.sync();
});

insertColumn(index, values)

Insere uma coluna no índice fornecido na tabela. Valores, se especificados, são definidos na nova coluna. Caso contrário, a coluna fica vazia.

insertColumn(index: number, values?: string[]): void;

Parâmetros

index

number

Índice em que a coluna será inserida na tabela.

values

string[]

Opcional. Cadeias de caracteres a inserir na nova coluna, especificada como uma matriz. Não pode ter mais valores que linhas na tabela.

Retornos

void

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, insert a column at index two.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            table.insertColumn(2, ["cell0", "cell1"]);
        }
    }
    await context.sync();
});

insertRow(index, values)

Insere uma linha no índice fornecido na tabela. Valores, se especificados, são definidos na nova linha. Caso contrário, a linha fica vazia.

insertRow(index: number, values?: string[]): OneNote.TableRow;

Parâmetros

index

number

Índice em que a linha será inserida na tabela.

values

string[]

Opcional. Cadeias de caracteres a inserir na nova linha, especificadas como uma matriz. Não pode ter mais valores que colunas na tabela.

Retornos

OneNote.TableRow

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, insert a row at index two.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            const row = table.insertRow(2, ["cell0", "cell1"]);
        }
    }
    await context.sync();
});

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.TableLoadOptions): OneNote.Table;

Parâmetros

options
OneNote.Interfaces.TableLoadOptions

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

Retornos

OneNote.Table

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

Parâmetros

propertyNames

string | string[]

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

Retornos

OneNote.Table

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/type");
    
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    const paragraphs = outline.paragraphs;
    
    // For each table, log properties.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            context.load(table);
            await context.sync();

            console.log("Table Id: " + table.id);
            console.log("Row Count: " + table.rowCount);
            console.log("Column Count: " + table.columnCount);
            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.Table;

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

OneNote.Table

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.TableUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
OneNote.Interfaces.TableUpdateData

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: OneNote.Table): void;

Parâmetros

properties
OneNote.Table

Retornos

void

setShadingColor(colorCode)

Define a cor de sombreamento de todas as células na tabela. O código de cor para o qual definir as células.

setShadingColor(colorCode: string): void;

Parâmetros

colorCode

string

Retornos

void

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

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

toJSON(): OneNote.Interfaces.TableData;

Retornos

OneNote.Interfaces.TableData

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

Retornos

OneNote.Table

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

Retornos

OneNote.Table