Compartilhar via

OneNote.Outline class

  • Referência
Pacote:
onenote

Representa um contêiner para objetos Paragraph.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Propriedades

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 do objeto Outline.
pageContent

Obtém o objeto PageContent que contém o Outline. Este objeto define a posição do Outline na página.
paragraphs

Obtém a coleção de objetos Paragraph presentes no Outline.

Métodos

appendHtml(html)

Adiciona a HTML especificada na parte inferior da estrutura de tópicos.
appendImage(base64EncodedImage, width, height)

Adiciona a imagem especificada na parte inferior de Outline.
appendRichText(paragraphText)

Adiciona o texto especificado na parte inferior de Outline.
appendTable(rowCount, columnCount, values)

Adiciona uma tabela com a quantidade especificada de linhas e colunas na parte inferior da estrutura de tópicos.
isTitle()

Verifique se o destaque é um destaque do título.
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.
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.Outline é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como OneNote.Interfaces.OutlineData) 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

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 do objeto Outline.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

pageContent

Obtém o objeto PageContent que contém o Outline. Este objeto define a posição do Outline na página.

readonly pageContent: OneNote.PageContent;

Valor da propriedade

OneNote.PageContent

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

paragraphs

Obtém a coleção de objetos Paragraph presentes no Outline.

readonly paragraphs: OneNote.ParagraphCollection;

Valor da propriedade

OneNote.ParagraphCollection

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Detalhes do método

appendHtml(html)

Adiciona a HTML especificada na parte inferior da estrutura de tópicos.

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) => {

    // Gets the active page.
    const activePage = context.application.getActivePage();

    // Get pageContents of the activePage.
    const pageContents = activePage.contents;

    // Queue a command to load the pageContents to access its data.
    context.load(pageContents);

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    if (pageContents.items.length != 0 && pageContents.items[0].type == "Outline")
    {
        // First item is an outline.
        const outline = pageContents.items[0].outline;

        // Queue a command to append a paragraph to the outline.
        outline.appendHtml("<p>new paragraph</p>");

        // Run the queued commands.
        await context.sync();
    }
});

appendImage(base64EncodedImage, width, height)

Adiciona a imagem especificada na parte inferior de Outline.

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 na parte inferior de Outline.

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 ]

appendTable(rowCount, columnCount, values)

Adiciona uma tabela com a quantidade especificada de linhas e colunas na parte inferior da estrutura de tópicos.

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 ]

Exemplos

await OneNote.run(async (context) => {

    // Gets the active page.
    const activePage = context.application.getActivePage();

    // Get pageContents of the activePage.
    const pageContents = activePage.contents;

    // Queue a command to load the pageContents to access its data.
    context.load(pageContents);

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    if (pageContents.items.length != 0 && pageContents.items[0].type == "Outline") {
        // First item is an outline.
        const outline = pageContents.items[0].outline;

        // Queue a command to append a paragraph to the outline.
        outline.appendTable(2, 2, [["1", "2"],["3", "4"]]);

        // Run the queued commands.
        await context.sync();
    }
});

isTitle()

Verifique se o destaque é um destaque do título.

isTitle(): OfficeExtension.ClientResult<boolean>;

Retornos

OfficeExtension.ClientResult<boolean>

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.OutlineLoadOptions): OneNote.Outline;

Parâmetros

options
OneNote.Interfaces.OutlineLoadOptions

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

Retornos

OneNote.Outline

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

Parâmetros

propertyNames

string | string[]

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

Retornos

OneNote.Outline

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

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

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

toJSON(): OneNote.Interfaces.OutlineData;

Retornos

OneNote.Interfaces.OutlineData

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

Retornos

OneNote.Outline

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

Retornos

OneNote.Outline