Compartilhar via

OneNote.TableCell class

  • Referência
Pacote:
onenote

Representa uma célula em uma tabela do OneNote.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Propriedades

cellIndex

Obtém o índice da célula em sua 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 célula.
paragraphs

Obtém o conjunto de objetos Paragraph presentes em TableCell.
parentRow

Obtém a linha pai da célula.
rowIndex

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

Obtém e define a cor de sombreamento da célula.

Métodos

appendHtml(html)

Adiciona o HTML especificado na parte inferior de TableCell.
appendImage(base64EncodedImage, width, height)

Adiciona a imagem especificada à célula da tabela.
appendRichText(paragraphText)

Adiciona o texto especificado à célula da tabela.
appendTable(rowCount, columnCount, values)

Adiciona uma tabela com a quantidade especificada de linhas e colunas na célula da tabela.
clear()

Limpa o conteúdo da célula.
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.
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.TableCell é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como OneNote.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.
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

cellIndex

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

readonly cellIndex: 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 célula.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

paragraphs

Obtém o conjunto de objetos Paragraph presentes em TableCell.

readonly paragraphs: OneNote.ParagraphCollection;

Valor da propriedade

OneNote.ParagraphCollection

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

parentRow

Obtém a linha pai da célula.

readonly parentRow: OneNote.TableRow;

Valor da propriedade

OneNote.TableRow

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

rowIndex

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

readonly rowIndex: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

shadingColor

Obtém e define a cor de sombreamento da célula.

shadingColor: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Detalhes do método

appendHtml(html)

Adiciona o HTML especificado na parte inferior de TableCell.

appendHtml(html: string): void;

Parâmetros

html

string

A cadeia de caracteres HTML para acrescentar. Veja HTML suportado para a API JavaScript de suplementos do OneNote.

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, get a table cell at row one and column two and add "Hello".
    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(1 /*Row Index*/, 2 /*Column Index*/);
            cell.appendHtml("<p>Hello</p>");
        }
    }
    await context.sync();
});

appendImage(base64EncodedImage, width, height)

Adiciona a imagem especificada à célula da tabela.

appendImage(base64EncodedImage: string, width: number, height: number): OneNote.Image;

Parâmetros

base64EncodedImage

string

Cadeia de caracteres HTML para acrescentar.

width

number

Opcional. Largura na unidade de pontos. O valor padrão é nulo, e será respeitada a largura da imagem.

height

number

Opcional. Altura na unidade de pontos. O valor padrão é nulo, e será respeitada a altura da imagem.

Retornos

OneNote.Image

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

appendRichText(paragraphText)

Adiciona o texto especificado à célula da tabela.

appendRichText(paragraphText: string): OneNote.RichText;

Parâmetros

paragraphText

string

Cadeia de caracteres HTML para acrescentar.

Retornos

OneNote.RichText

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Exemplos

await OneNote.run(async (context) => {
    const app = context.application;
    const outline = app.getActiveOutline();
    const appendedRichText = null;
    
    // 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 table cell at row one and column two and add "Hello".
    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(1 /*Row Index*/, 2 /*Column Index*/);
            appendedRichText = cell.appendRichText("Hello");
        }
    }
    await context.sync();
});

appendTable(rowCount, columnCount, values)

Adiciona uma tabela com a quantidade especificada de linhas e colunas na célula da tabela.

appendTable(rowCount: number, columnCount: number, values?: string[][]): OneNote.Table;

Parâmetros

rowCount

number

Obrigatório. A quantidade de linhas na tabela.

columnCount

number

Obrigatório. A quantidade de colunas na tabela.

values

string[][]

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

Retornos

OneNote.Table

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

clear()

Limpa o conteúdo da célula.

clear(): void;

Retornos

void

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

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.TableCellLoadOptions): OneNote.TableCell;

Parâmetros

options
OneNote.Interfaces.TableCellLoadOptions

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

Retornos

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

Parâmetros

propertyNames

string | string[]

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

Retornos

OneNote.TableCell

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 table cell at row one and column two.
    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(1 /*Row Index*/, 2 /*Column Index*/);
            
            // Queue a command to load the table cell.
            context.load(cell);
            await context.sync();

            console.log("Cell Id: " + cell.id);
            console.log("Cell Index: " + cell.cellIndex);
            console.log("Cell's Row Index: " + cell.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.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

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

Parâmetros

properties
OneNote.TableCell

Retornos

void

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

toJSON(): OneNote.Interfaces.TableCellData;

Retornos

OneNote.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.

track(): OneNote.TableCell;

Retornos

OneNote.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(): OneNote.TableCell;

Retornos

OneNote.TableCell