Compartilhar via

OneNote.Paragraph class

  • Referência
Pacote:
onenote

Um contêiner para o conteúdo visível em uma página. Um parágrafo pode conter qualquer tipo de ParagraphType de conteúdo.

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 Paragraph.
image

Obtém o objeto Image em Paragraph. Gerará uma exceção se ParagraphType não for uma imagem.
inkWords

Obtém a coleção de tinta no Paragraph. Gerará uma exceção se ParagraphType não for um Ink.
outline

Obtém o objeto Outline que contém Paragraph.
paragraphs

A coleção de parágrafos sob este parágrafo.
parentParagraph

Obtém o objeto do parágrafo pai. Gerará se um parágrafo pai não existir.
parentParagraphOrNull

Obtém o objeto do parágrafo pai. Devolve nulo se não existir um parágrafo principal.
parentTableCell

Obtém o objeto TableCell que contém o Paragraph se houver. Se o elemento principal não for um TableCell, o lança ItemNotFound.
parentTableCellOrNull

Obtém o objeto TableCell que contém o Paragraph se houver. Se o elemento principal não for um TableCell, devolve nulo.
richText

Obtém o objeto RichText em Paragraph. Gerará uma exceção se ParagraphType não for um RichText. Somente leitura
table

Obtém o objeto Table em Paragraph. Gera uma exceção se ParagraphType não for Uma Tabela.
type

Obtém o tipo do objeto Paragraph.

Métodos

addNoteTag(type, status)

Adicione NoteTag ao parágrafo.
addNoteTag(typeString, statusString)

Adicione NoteTag ao parágrafo.
delete()

Exclui o parágrafo
getParagraphInfo()

Obter informações da lista de parágrafos
insertHtmlAsSibling(insertLocation, html)

Insere o conteúdo HTML especificado
insertHtmlAsSibling(insertLocationString, html)

Insere o conteúdo HTML especificado
insertImageAsSibling(insertLocation, base64EncodedImage, width, height)

Insere a imagem no local especificado.
insertImageAsSibling(insertLocationString, base64EncodedImage, width, height)

Insere a imagem no local especificado.
insertRichTextAsSibling(insertLocation, paragraphText)

Insere o texto do parágrafo no local especificado.
insertRichTextAsSibling(insertLocationString, paragraphText)

Insere o texto do parágrafo no local especificado.
insertTableAsSibling(insertLocation, rowCount, columnCount, values)

Adiciona uma tabela com a quantidade especificada de linhas e colunas antes ou depois do parágrafo atual.
insertTableAsSibling(insertLocationString, rowCount, columnCount, values)

Adiciona uma tabela com a quantidade especificada de linhas e colunas antes ou depois do parágrafo atual.
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.Paragraph é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como OneNote.Interfaces.ParagraphData) 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 Paragraph.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

image

Obtém o objeto Image em Paragraph. Gerará uma exceção se ParagraphType não for uma imagem.

readonly image: OneNote.Image;

Valor da propriedade

OneNote.Image

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

inkWords

Obtém a coleção de tinta no Paragraph. Gerará uma exceção se ParagraphType não for um Ink.

readonly inkWords: OneNote.InkWordCollection;

Valor da propriedade

OneNote.InkWordCollection

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

outline

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

readonly outline: OneNote.Outline;

Valor da propriedade

OneNote.Outline

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

paragraphs

A coleção de parágrafos sob este parágrafo.

readonly paragraphs: OneNote.ParagraphCollection;

Valor da propriedade

OneNote.ParagraphCollection

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

parentParagraph

Obtém o objeto do parágrafo pai. Gerará se um parágrafo pai não existir.

readonly parentParagraph: OneNote.Paragraph;

Valor da propriedade

OneNote.Paragraph

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

parentParagraphOrNull

Obtém o objeto do parágrafo pai. Devolve nulo se não existir um parágrafo principal.

readonly parentParagraphOrNull: OneNote.Paragraph;

Valor da propriedade

OneNote.Paragraph

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

parentTableCell

Obtém o objeto TableCell que contém o Paragraph se houver. Se o elemento principal não for um TableCell, o lança ItemNotFound.

readonly parentTableCell: OneNote.TableCell;

Valor da propriedade

OneNote.TableCell

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

parentTableCellOrNull

Obtém o objeto TableCell que contém o Paragraph se houver. Se o elemento principal não for um TableCell, devolve nulo.

readonly parentTableCellOrNull: OneNote.TableCell;

Valor da propriedade

OneNote.TableCell

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

richText

Obtém o objeto RichText em Paragraph. Gerará uma exceção se ParagraphType não for um RichText. Somente leitura

readonly richText: OneNote.RichText;

Valor da propriedade

OneNote.RichText

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

table

Obtém o objeto Table em Paragraph. Gera uma exceção se ParagraphType não for Uma Tabela.

readonly table: OneNote.Table;

Valor da propriedade

OneNote.Table

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

type

Obtém o tipo do objeto Paragraph.

readonly type: OneNote.ParagraphType | "RichText" | "Image" | "Table" | "Ink" | "Other";

Valor da propriedade

OneNote.ParagraphType | "RichText" | "Image" | "Table" | "Ink" | "Other"

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Detalhes do método

addNoteTag(type, status)

Adicione NoteTag ao parágrafo.

addNoteTag(type: OneNote.NoteTagType, status: OneNote.NoteTagStatus): OneNote.NoteTag;

Parâmetros

type
OneNote.NoteTagType

O tipo de NoteTag.

status
OneNote.NoteTagStatus

O status do NoteTag.

Retornos

OneNote.NoteTag

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

addNoteTag(typeString, statusString)

Adicione NoteTag ao parágrafo.

addNoteTag(typeString: "Unknown" | "ToDo" | "Important" | "Question" | "Contact" | "Address" | "PhoneNumber" | "Website" | "Idea" | "Critical" | "ToDoPriority1" | "ToDoPriority2", statusString: "Unknown" | "Normal" | "Completed" | "Disabled" | "OutlookTask" | "TaskNotSyncedYet" | "TaskRemoved"): OneNote.NoteTag;

Parâmetros

typeString

"Unknown" | "ToDo" | "Important" | "Question" | "Contact" | "Address" | "PhoneNumber" | "Website" | "Idea" | "Critical" | "ToDoPriority1" | "ToDoPriority2"

O tipo de NoteTag.

statusString

"Unknown" | "Normal" | "Completed" | "Disabled" | "OutlookTask" | "TaskNotSyncedYet" | "TaskRemoved"

O status do NoteTag.

Retornos

OneNote.NoteTag

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

delete()

Exclui o parágrafo

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Exemplos

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

    // Get the collection of pageContent items from the page.
    const pageContents = context.application.getActivePage().contents;

    // Get the first PageContent on the page assuming its an outline, get the outline's paragraphs.
    const pageContent = pageContents.getItemAt(0);
    
    const paragraphs = pageContent.outline.paragraphs;
    
    const firstParagraph = paragraphs.getItemAt(0);
    
    // Queue a command to load the id and type of the first paragraph.
    firstParagraph.load("id,type");

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
            
    // Queue a command to delete the first paragraph.
    firstParagraph.delete();
    
    // Run the command to delete it.
    await context.sync();
});

getParagraphInfo()

Obter informações da lista de parágrafos

getParagraphInfo(): OfficeExtension.ClientResult<OneNote.ParagraphInfo>;

Retornos

OfficeExtension.ClientResult<OneNote.ParagraphInfo>

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

insertHtmlAsSibling(insertLocation, html)

Insere o conteúdo HTML especificado

insertHtmlAsSibling(insertLocation: OneNote.InsertLocation, html: string): void;

Parâmetros

insertLocation
OneNote.InsertLocation

O local de novos conteúdos em relação ao Parágrafo atual.

html

string

Uma cadeia de caracteres HTML que descreve a apresentação visual do conteúdo. 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) => {

    // Get the collection of pageContent items from the page.
    const pageContents = context.application.getActivePage().contents;

    // Get the first PageContent on the page.
    // Assuming its an outline, get the outline's paragraphs.
    const pageContent = pageContents.getItemAt(0);
    const paragraphs = pageContent.outline.paragraphs;
    const firstParagraph = paragraphs.getItemAt(0);

    // Queue a command to load the id and type of the first paragraph.
    firstParagraph.load("id,type");

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    // Queue commands to insert before and after the first paragraph.
    firstParagraph.insertHtmlAsSibling("Before", "<p>ContentBeforeFirstParagraph</p>");
    firstParagraph.insertHtmlAsSibling("After", "<p>ContentAfterFirstParagraph</p>");
    
    // Run the command to run inserts.
    await context.sync();
});

insertHtmlAsSibling(insertLocationString, html)

Insere o conteúdo HTML especificado

insertHtmlAsSibling(insertLocationString: "Before" | "After", html: string): void;

Parâmetros

insertLocationString

"Before" | "After"

O local de novos conteúdos em relação ao Parágrafo atual.

html

string

Uma cadeia de caracteres HTML que descreve a apresentação visual do conteúdo. Veja HTML suportado para a API JavaScript de suplementos do OneNote.

Retornos

void

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

insertImageAsSibling(insertLocation, base64EncodedImage, width, height)

Insere a imagem no local especificado.

insertImageAsSibling(insertLocation: OneNote.InsertLocation, base64EncodedImage: string, width: number, height: number): OneNote.Image;

Parâmetros

insertLocation
OneNote.InsertLocation

O local da tabela em relação ao Paragraph atual.

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 ]

Exemplos

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

    // Get the collection of pageContent items from the page.
    const pageContents = context.application.getActivePage().contents;

    // Get the first PageContent on the page.
    // Assuming its an outline, get the outline's paragraphs.
    const pageContent = pageContents.getItemAt(0);
    const paragraphs = pageContent.outline.paragraphs;
    const firstParagraph = paragraphs.getItemAt(0);

    // Queue a command to load the id and type of the first paragraph.
    firstParagraph.load("id,type");

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    // Queue commands to insert before and after the first paragraph.
    firstParagraph.insertImageAsSibling("Before", "R0lGODlhDwAPAKECAAAAzMzM/////wAAACwAAAAADwAPAAACIISPeQHsrZ5ModrLlN48CXF8m2iQ3YmmKqVlRtW4MLwWACH+H09wdGltaXplZCBieSBVbGVhZCBTbWFydFNhdmVyIQAAOw==");
    firstParagraph.insertImageAsSibling("After", "R0lGODlhDwAPAKECAAAAzMzM/////wAAACwAAAAADwAPAAACIISPeQHsrZ5ModrLlN48CXF8m2iQ3YmmKqVlRtW4MLwWACH+H09wdGltaXplZCBieSBVbGVhZCBTbWFydFNhdmVyIQAAOw==");
    
    // Run the command to insert images.
    await context.sync();
});

insertImageAsSibling(insertLocationString, base64EncodedImage, width, height)

Insere a imagem no local especificado.

insertImageAsSibling(insertLocationString: "Before" | "After", base64EncodedImage: string, width: number, height: number): OneNote.Image;

Parâmetros

insertLocationString

"Before" | "After"

O local da tabela em relação ao Paragraph atual.

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 ]

insertRichTextAsSibling(insertLocation, paragraphText)

Insere o texto do parágrafo no local especificado.

insertRichTextAsSibling(insertLocation: OneNote.InsertLocation, paragraphText: string): OneNote.RichText;

Parâmetros

insertLocation
OneNote.InsertLocation

O local da tabela em relação ao Paragraph atual.

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

    // Get the collection of pageContent items from the page.
    const pageContents = context.application.getActivePage().contents;

    // Get the first PageContent on the page assuming its an outline, get the outline's paragraphs.
    const pageContent = pageContents.getItemAt(0);
    const paragraphs = pageContent.outline.paragraphs;
    const firstParagraph = paragraphs.getItemAt(0);

    // Queue a command to load the id and type of the first paragraph.
    firstParagraph.load("id,type");

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    // Queue commands to insert before and after the first paragraph.
    firstParagraph.insertRichTextAsSibling("Before", "Text Appears Before Paragraph");
    firstParagraph.insertRichTextAsSibling("After", "Text Appears After Paragraph");
    
    // Run the command to insert text contents.
    await context.sync();
});

insertRichTextAsSibling(insertLocationString, paragraphText)

Insere o texto do parágrafo no local especificado.

insertRichTextAsSibling(insertLocationString: "Before" | "After", paragraphText: string): OneNote.RichText;

Parâmetros

insertLocationString

"Before" | "After"

O local da tabela em relação ao Paragraph atual.

paragraphText

string

Cadeia de caracteres HTML para acrescentar.

Retornos

OneNote.RichText

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

insertTableAsSibling(insertLocation, rowCount, columnCount, values)

Adiciona uma tabela com a quantidade especificada de linhas e colunas antes ou depois do parágrafo atual.

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

Parâmetros

insertLocation
OneNote.InsertLocation

O local da tabela em relação ao Paragraph atual.

rowCount

number

O número de linhas na tabela.

columnCount

number

O número 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 ]

insertTableAsSibling(insertLocationString, rowCount, columnCount, values)

Adiciona uma tabela com a quantidade especificada de linhas e colunas antes ou depois do parágrafo atual.

insertTableAsSibling(insertLocationString: "Before" | "After", rowCount: number, columnCount: number, values?: string[][]): OneNote.Table;

Parâmetros

insertLocationString

"Before" | "After"

O local da tabela em relação ao Paragraph atual.

rowCount

number

O número de linhas na tabela.

columnCount

number

O número 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 ]

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.ParagraphLoadOptions): OneNote.Paragraph;

Parâmetros

options
OneNote.Interfaces.ParagraphLoadOptions

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

Retornos

OneNote.Paragraph

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

Parâmetros

propertyNames

string | string[]

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

Retornos

OneNote.Paragraph

Exemplos

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

    // Get the collection of pageContent items from the page.
    const pageContents = context.application.getActivePage().contents;
    
    // Queue a command to load the outline property of each pageContent.
    pageContents.load("outline");
        
    // Get the first PageContent on the page, and then get its Outline.
    const pageContent = pageContents._GetItem(0);
    const paragraphs = pageContent.outline.paragraphs;
            
    // Queue a command to load the id and type of each paragraph.
    paragraphs.load("id,type");
            
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    // Write the text.
    $.each(paragraphs.items, function(index, paragraph) {
        console.log("Paragraph type: " + paragraph.type);
        console.log("Paragraph ID: " + paragraph.id);
    });
});

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

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

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

Parâmetros

properties
OneNote.Interfaces.ParagraphUpdateData

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

Parâmetros

properties
OneNote.Paragraph

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

toJSON(): OneNote.Interfaces.ParagraphData;

Retornos

OneNote.Interfaces.ParagraphData

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

Retornos

OneNote.Paragraph

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

Retornos

OneNote.Paragraph