OneNote.RichText class
Representa un objeto RichText en un Paragraph.
- Extends
Comentarios
[ Conjunto de API: OneNoteApi 1.1 ]
Propiedades
context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
id | Obtiene el identificador del objeto RichText. Solo lectura. |
language |
El identificador de idioma del texto. Solo lectura. |
paragraph | Obtiene el objeto Paragraph que contiene el objeto RichText. Solo lectura. |
style | Obtiene el estilo de texto del objeto RichText. Solo lectura. |
text | Obtiene el contenido de texto del objeto RichText. Solo lectura. |
Métodos
get |
Obtener el HTML del texto enriquecido |
load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
toJSON() | Invalida el método JavaScript |
track() | Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para |
untrack() | Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para |
Detalles de las propiedades
context
Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
context: RequestContext;
Valor de propiedad
id
Obtiene el identificador del objeto RichText. Solo lectura.
readonly id: string;
Valor de propiedad
string
Comentarios
languageId
El identificador de idioma del texto. Solo lectura.
readonly languageId: string;
Valor de propiedad
string
Comentarios
paragraph
Obtiene el objeto Paragraph que contiene el objeto RichText. Solo lectura.
readonly paragraph: OneNote.Paragraph;
Valor de propiedad
Comentarios
style
Obtiene el estilo de texto del objeto RichText. Solo lectura.
readonly style: OneNote.ParagraphStyle;
Valor de propiedad
Comentarios
text
Obtiene el contenido de texto del objeto RichText. Solo lectura.
readonly text: string;
Valor de propiedad
string
Comentarios
Detalles del método
getHtml()
Obtener el HTML del texto enriquecido
getHtml(): OfficeExtension.ClientResult<string>;
Devoluciones
OfficeExtension.ClientResult<string>
Html del texto enriquecido
Comentarios
load(options)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync()
antes de leer las propiedades.
load(options?: OneNote.Interfaces.RichTextLoadOptions): OneNote.RichText;
Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
load(propertyNames)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync()
antes de leer las propiedades.
load(propertyNames?: string | string[]): OneNote.RichText;
Parámetros
- propertyNames
-
string | string[]
Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.
Devoluciones
Ejemplos
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)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync()
antes de leer las propiedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): OneNote.RichText;
Parámetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand
es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.
Devoluciones
toJSON()
Invalida el método JavaScript toJSON()
para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify()
. (JSON.stringify
a su vez, llama al toJSON
método del objeto que se le pasa). Mientras que el objeto OneNote.RichText original es un objeto de API, el toJSON
método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.RichTextData
) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): OneNote.Interfaces.RichTextData;
Devoluciones
track()
Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject)
. Si usa este objeto entre .sync
llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe haber agregado el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez.
track(): OneNote.RichText;
Devoluciones
untrack()
Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject)
. Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync()
a antes de que la versión de memoria surta efecto.
untrack(): OneNote.RichText;
Devoluciones
Comentarios
https://aka.ms/ContentUserFeedback.
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea:Enviar y ver comentarios de