OneNote.RichText class
Representa um objeto RichText em um Paragraph.
- Extends
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 RichText. |
| language |
A id de idioma do texto. |
| paragraph | Obtém o objeto Paragraph que contém o objeto RichText. |
| style | Obtém o estilo de texto do objeto RichText. Somente leitura. |
| text | Obtém o conteúdo de texto do objeto RichText. Somente leitura. |
Métodos
| get |
Obtém o HTML do rich text. |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| toJSON() | Substitui o método JavaScript |
| 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 |
| 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 |
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
id
Obtém a ID do objeto RichText.
readonly id: string;Valor da propriedade
string
Comentários
languageId
A id de idioma do texto.
readonly languageId: string;Valor da propriedade
string
Comentários
paragraph
Obtém o objeto Paragraph que contém o objeto RichText.
readonly paragraph: OneNote.Paragraph;Valor da propriedade
Comentários
style
Obtém o estilo de texto do objeto RichText. Somente leitura.
readonly style: OneNote.ParagraphStyle;Valor da propriedade
Comentários
text
Obtém o conteúdo de texto do objeto RichText. Somente leitura.
readonly text: string;Valor da propriedade
string
Comentários
Detalhes do método
getHtml()
Obtém o HTML do rich text.
getHtml(): OfficeExtension.ClientResult<string>;Retornos
OfficeExtension.ClientResult<string>
O html do texto formatado
Comentários
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.RichTextLoadOptions): OneNote.RichText;Parâmetros
Fornece opções para as propriedades do objeto a carregar.
Retornos
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.RichText;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
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, and then get its outline's paragraphs.
const outlinePageContents = pageContents.getItem(0);
let paragraphs = outlinePageContents.outline.paragraphs;
const richTextParagraphs = paragraphs.items;
// Queue a command to load the id and type of each page content in the outline.
pageContents.load("id,type");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Load all page contents of type Outline.
$.each(pageContents.items, function(index, pageContent) {
if(pageContent.type == 'Outline')
{
pageContent.load('outline,outline/paragraphs,outline/paragraphs/type');
outlinePageContents.push(pageContent);
}
});
await context.sync();
// Load all rich text paragraphs across outlines.
$.each(outlinePageContents, function(index, outlinePageContent) {
const outline = outlinePageContent.outline;
paragraphs = paragraphs.concat(outline.paragraphs.items);
});
$.each(paragraphs, function(index, paragraph) {
if(paragraph.type == 'RichText')
{
richTextParagraphs.push(paragraph);
paragraph.load("id,richText/text");
}
});
await context.sync();
// Display all rich text paragraphs to the console.
$.each(richTextParagraphs, function(index, richTextParagraph) {
const richText = richTextParagraph.richText;
console.log(
"Paragraph found with richtext content : " +
richText.text + " and richtext id : " + richText.id);
});
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.RichText;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
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.RichText é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como OneNote.Interfaces.RichTextData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): OneNote.Interfaces.RichTextData;Retornos
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.RichText;Retornos
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.RichText;