OneNote.Table class

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

Comentários

Conjunto de APIs: OneNoteApi 1.1

Obtém a quantidade de colunas na tabela.

readonly columnCount: number;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Obtém a ID da tabela.

readonly id: string;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

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

readonly paragraph: OneNote.Paragraph;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

Obtém a quantidade de linhas na tabela.

readonly rowCount: number;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

Obtém todas as linhas da tabela.

readonly rows: OneNote.TableRowCollection;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

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

Retornos

Comentários

Conjunto de APIs: 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();
});

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

Retornos

Comentários

Conjunto de APIs: 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();
});

Limpa o conteúdo da tabela.

clear(): void;

Retornos

Comentários

Conjunto de APIs: OneNoteApi 1.1

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

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: 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();
});

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

Retornos

Comentários

Conjunto de APIs: 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();
});

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

Retornos

Comentários

Conjunto de APIs: 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();
});

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

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

Parâmetros

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/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();
        }
    }
});

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

Retornos

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

Retornos

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

set(properties: OneNote.Table): void;

Parâmetros

Retornos

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

Retornos

Comentários

Conjunto de APIs: OneNoteApi 1.1

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original OneNote.Table é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como OneNote.Interfaces.TableData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): OneNote.Interfaces.TableData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse 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, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez.

track(): OneNote.Table;

Retornos

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de 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. Você precisará ligar context.sync() antes que a liberação de memória entre em vigor.

untrack(): OneNote.Table;

Retornos