Excel.CommentReplyCollection class
Representa uma coleção de objetos de resposta de comentário que fazem parte do comentário.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.10 ]
Propriedades
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| items | Obtém os itens filhos carregados nesta coleção. |
Métodos
| add(content, content |
Cria uma resposta de comentário para um comentário. |
| add(content, content |
Cria uma resposta de comentário para um comentário. |
| get |
Obtém o número de respostas de comentários na coleção. |
| get |
Retorna uma resposta de comentário identificada pela respectiva ID. |
| get |
Obtém uma resposta de comentário com base em sua posição na coleção. |
| get |
Retorna uma resposta de comentário identificada pela respectiva ID. Se o objeto de resposta de comentário não existir, esse método retornará um objeto com sua |
| 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 |
Detalhes da propriedade
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
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Excel.CommentReply[];Valor da propriedade
Detalhes do método
add(content, contentType)
Cria uma resposta de comentário para um comentário.
add(content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.CommentReply;Parâmetros
- content
-
Excel.CommentRichContent | string
O conteúdo do comentário. Isso pode ser uma cadeia de caracteres ou um CommentRichContent objeto (por exemplo, para comentários com menções). [Conjunto de API: ExcelApi 1.10 para cadeia de caracteres, 1.11 para objeto CommentRichContent]
- contentType
- Excel.ContentType
Opcional. O tipo de conteúdo contido no comentário. O valor padrão é enumerar ContentType.Plain. [Conjunto de API: ExcelApi 1.10 para Enum ContentType.Plain, 1.11 para Enum ContentType.Mention]
Retornos
Comentários
[ Conjunto de API: ExcelApi 1.10 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-replies.yaml
await Excel.run(async (context) => {
// Adds a reply to the first comment in this worksheet.
const sheet = context.workbook.worksheets.getItem("Comments");
const comment = sheet.comments.getItemAt(0);
comment.replies.add("Add content to this worksheet.");
await context.sync();
});
add(content, contentTypeString)
Cria uma resposta de comentário para um comentário.
add(content: CommentRichContent | string, contentTypeString?: "Plain" | "Mention"): Excel.CommentReply;Parâmetros
- content
-
Excel.CommentRichContent | string
O conteúdo do comentário. Isso pode ser uma cadeia de caracteres ou um CommentRichContent objeto (por exemplo, para comentários com menções). [Conjunto de API: ExcelApi 1.10 para cadeia de caracteres, 1.11 para objeto CommentRichContent]
- contentTypeString
-
"Plain" | "Mention"
Opcional. O tipo de conteúdo contido no comentário. O valor padrão é enumerar ContentType.Plain. [Conjunto de API: ExcelApi 1.10 para Enum ContentType.Plain, 1.11 para Enum ContentType.Mention]
Retornos
Comentários
getCount()
Obtém o número de respostas de comentários na coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
getItem(commentReplyId)
Retorna uma resposta de comentário identificada pela respectiva ID.
getItem(commentReplyId: string): Excel.CommentReply;Parâmetros
- commentReplyId
-
string
O identificador da resposta de comentário.
Retornos
Comentários
getItemAt(index)
Obtém uma resposta de comentário com base em sua posição na coleção.
getItemAt(index: number): Excel.CommentReply;Parâmetros
- index
-
number
O valor do índice da resposta de comentário a ser recuperada. A coleção usa indexação baseada em zero.
Retornos
Comentários
getItemOrNullObject(commentReplyId)
Retorna uma resposta de comentário identificada pela respectiva ID. Se o objeto de resposta de comentário não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getItemOrNullObject(commentReplyId: string): Excel.CommentReply;Parâmetros
- commentReplyId
-
string
O identificador da resposta de comentário.
Retornos
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?: Excel.Interfaces.CommentReplyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentReplyCollection;Parâmetros
Fornece opções para quais propriedades do objeto 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[]): Excel.CommentReplyCollection;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
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?: OfficeExtension.LoadOption): Excel.CommentReplyCollection;Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
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.) Considerando que o objeto original Excel.CommentReplyCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.CommentReplyCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.CommentReplyCollectionData;Retornos
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de