Word.CommentContentRange class

Paquete:

word

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: WordApi 1.4 ]

Propiedades

bold	Especifica un valor que indica si el texto del comentario está en negrita.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
hyperlink	Obtiene el primer hipervínculo del intervalo, o establece un hipervínculo en el intervalo. Todos los hipervínculos del intervalo se eliminan cuando establece un hipervínculo nuevo en el intervalo.
isEmpty	Comprueba si la longitud del intervalo es cero.
italic	Especifica un valor que indica si el texto del comentario está en cursiva.
strikeThrough	Especifica un valor que indica si el texto del comentario tiene un tachado.
text	Obtiene el texto del intervalo de comentarios.
underline	Especifica un valor que indica el tipo de subrayado del texto del comentario. 'None' si el texto del comentario no está subrayado.

Métodos

insertText(text, insertLocation)	Inserta texto en en la ubicación especificada. Nota: Para el comentario moderno, el intervalo de contenido del que se realiza el seguimiento en contexto se vuelve vacío si se publica alguna revisión del comentario a través de la interfaz de usuario.
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(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
set(properties, options)	Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties)	Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
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.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el Word original. El objeto CommentContentRange es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.CommentContentRangeData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
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 obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.
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.

Detalles de las propiedades

bold

Especifica un valor que indica si el texto del comentario está en negrita.

bold: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.4 ]

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

Word.RequestContext

hyperlink

Obtiene el primer hipervínculo del intervalo, o establece un hipervínculo en el intervalo. Todos los hipervínculos del intervalo se eliminan cuando establece un hipervínculo nuevo en el intervalo.

hyperlink: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.4 ]

isEmpty

Comprueba si la longitud del intervalo es cero.

readonly isEmpty: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.4 ]

italic

Especifica un valor que indica si el texto del comentario está en cursiva.

italic: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.4 ]

strikeThrough

Especifica un valor que indica si el texto del comentario tiene un tachado.

strikeThrough: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.4 ]

text

Obtiene el texto del intervalo de comentarios.

readonly text: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.4 ]

underline

Especifica un valor que indica el tipo de subrayado del texto del comentario. 'None' si el texto del comentario no está subrayado.

underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";

Valor de propiedad

Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"

Comentarios

[ Conjunto de API: WordApi 1.4 ]

Detalles del método

insertText(text, insertLocation)

Inserta texto en en la ubicación especificada. Nota: Para el comentario moderno, el intervalo de contenido del que se realiza el seguimiento en contexto se vuelve vacío si se publica alguna revisión del comentario a través de la interfaz de usuario.

insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.CommentContentRange;

Parámetros

text

string

Obligatorio. Texto que se va a insertar en CommentContentRange.

insertLocation

Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Obligatorio. El valor debe ser "Replace", "Start", "End", "Before" o "After".

Devoluciones

Word.CommentContentRange

Comentarios

[ Conjunto de API: WordApi 1.4 ]

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?: Word.Interfaces.CommentContentRangeLoadOptions): Word.CommentContentRange;

Parámetros

options

Word.Interfaces.CommentContentRangeLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Word.CommentContentRange

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[]): Word.CommentContentRange;

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

Word.CommentContentRange

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;
        }): Word.CommentContentRange;

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

Word.CommentContentRange

set(properties, options)

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.

set(properties: Interfaces.CommentContentRangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties

Word.Interfaces.CommentContentRangeUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.

options

OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Word.CommentContentRange): void;

Parámetros

properties

Word.CommentContentRange

Devoluciones

void

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.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el Word original. El objeto CommentContentRange es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.CommentContentRangeData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Word.Interfaces.CommentContentRangeData;

Devoluciones

Word.Interfaces.CommentContentRangeData

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 obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.

track(): Word.CommentContentRange;

Devoluciones

Word.CommentContentRange

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(): Word.CommentContentRange;

Devoluciones

Word.CommentContentRange