Word.CommentContentRange class

Pacote:

word

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: WordApi 1.4 ]

Propriedades

bold	Especifica um valor que indica se o texto do comentário é em negrito.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
hyperlink	Obtém o primeiro hiperlink no intervalo ou define um hiperlink no intervalo. Todos os hiperlinks no intervalo são excluídos quando você configura um novo hiperlink no intervalo.
isEmpty	Verifica se o comprimento do intervalo é zero.
italic	Especifica um valor que indica se o texto de comentário está itálico.
strikeThrough	Especifica um valor que indica se o texto de comentário tem um strikethrough.
text	Obtém o texto do intervalo de comentários.
underline	Especifica um valor que indica o tipo de sublinhado do texto de comentário. "Nenhum" se o texto de comentário não for sublinhado.

Métodos

insertText(text, insertLocation)	Insere texto no local especificado. Observação: para o comentário moderno, o intervalo de conteúdo rastreado em todo o contexto se torna vazio se qualquer revisão no comentário for postada por meio da interface do usuário.
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. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
toJSON()	Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o Word original. O objeto CommentContentRange é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.CommentContentRangeData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
track()	Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse 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, você precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.
untrack()	Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa 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. Você precisará chamar context.sync() antes que a versão da memória entre em vigor.

Detalhes da propriedade

bold

Especifica um valor que indica se o texto do comentário é em negrito.

bold: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.4 ]

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Word.RequestContext

hyperlink

Obtém o primeiro hiperlink no intervalo ou define um hiperlink no intervalo. Todos os hiperlinks no intervalo são excluídos quando você configura um novo hiperlink no intervalo.

hyperlink: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.4 ]

isEmpty

Verifica se o comprimento do intervalo é zero.

readonly isEmpty: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.4 ]

italic

Especifica um valor que indica se o texto de comentário está itálico.

italic: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.4 ]

strikeThrough

Especifica um valor que indica se o texto de comentário tem um strikethrough.

strikeThrough: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.4 ]

text

Obtém o texto do intervalo de comentários.

readonly text: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.4 ]

underline

Especifica um valor que indica o tipo de sublinhado do texto de comentário. "Nenhum" se o texto de comentário não for sublinhado.

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 da propriedade

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

Comentários

[ Conjunto de API: WordApi 1.4 ]

Detalhes do método

insertText(text, insertLocation)

Insere texto no local especificado. Observação: para o comentário moderno, o intervalo de conteúdo rastreado em todo o contexto se torna vazio se qualquer revisão no comentário for postada por meio da interface do usuário.

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

Parâmetros

text

string

Obrigatório. O texto a ser inserido no CommentContentRange.

insertLocation

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

Obrigatório. O valor deve ser 'Replace', 'Start', 'End', 'Before' ou 'After'.

Retornos

Word.CommentContentRange

Comentários

[ Conjunto de API: WordApi 1.4 ]

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

Parâmetros

options

Word.Interfaces.CommentContentRangeLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Word.CommentContentRange

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

Parâmetros

propertyNames

string | string[]

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

Retornos

Word.CommentContentRange

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

Parâmetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Word.CommentContentRange

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

properties

Word.Interfaces.CommentContentRangeUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options

OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Word.CommentContentRange): void;

Parâmetros

properties

Word.CommentContentRange

Retornos

void

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o Word original. O objeto CommentContentRange é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.CommentContentRangeData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.CommentContentRangeData;

Retornos

Word.Interfaces.CommentContentRangeData

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse 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, você precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.

track(): Word.CommentContentRange;

Retornos

Word.CommentContentRange

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa 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. Você precisará chamar context.sync() antes que a versão da memória entre em vigor.

untrack(): Word.CommentContentRange;

Retornos

Word.CommentContentRange