Excel.CommentCollection class
Representa uma coleção de objetos de comentário que fazem parte do livro.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.10 ]
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. |
| items | Obtém os itens filhos carregados nesta coleção. |
Métodos
| add(cell |
Cria um novo comentário com o conteúdo fornecido na célula especificada. É |
| add(cell |
Cria um novo comentário com o conteúdo fornecido na célula especificada. É |
| get |
Obtém o número de comentários na coleção. |
| get |
Obtém um comentário da coleção com base em seu ID. |
| get |
Obtém um comentário da coleção com base em sua posição. |
| get |
Obtém o comentário da célula especificada. Se não existir nenhum comentário na célula, é gerado um erro. |
| get |
Obtém o comentário ao qual a resposta especificada está ligada. |
| 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 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
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Excel.Comment[];Valor da propriedade
Detalhes do método
add(cellAddress, content, contentType)
Cria um novo comentário com o conteúdo fornecido na célula especificada. É InvalidArgument apresentado um erro se o intervalo fornecido for maior do que uma célula.
add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.Comment;Parâmetros
- cellAddress
-
Excel.Range | string
A célula à qual o comentário é adicionado. Pode ser um Range objeto ou uma cadeia. Se for uma cadeia, tem de conter o endereço completo, incluindo o nome da folha. É InvalidArgument apresentado um erro se o intervalo fornecido for maior do que uma célula.
- content
-
Excel.CommentRichContent | string
O conteúdo do comentário. Isto pode ser uma cadeia ou CommentRichContent objeto. As cadeias são utilizadas para texto simples.
CommentRichContent os objetos permitem outras funcionalidades de comentários, como menções. [Conjunto de API: ExcelApi 1.10 para cadeia, 1.11 para o objeto CommentRichContent]
- contentType
- Excel.ContentType
Opcional. O tipo de conteúdo contido no comentário. O valor predefinido é enum 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-basics.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Comments");
// Note that an InvalidArgument error will be thrown if multiple cells passed to `comment.add`.
sheet.comments.add("A2", "TODO: add data.");
await context.sync();
});
add(cellAddress, content, contentTypeString)
Cria um novo comentário com o conteúdo fornecido na célula especificada. É InvalidArgument apresentado um erro se o intervalo fornecido for maior do que uma célula.
add(cellAddress: Range | string, content: CommentRichContent | string, contentTypeString?: "Plain" | "Mention"): Excel.Comment;Parâmetros
- cellAddress
-
Excel.Range | string
A célula à qual o comentário é adicionado. Pode ser um Range objeto ou uma cadeia. Se for uma cadeia, tem de conter o endereço completo, incluindo o nome da folha. É InvalidArgument apresentado um erro se o intervalo fornecido for maior do que uma célula.
- content
-
Excel.CommentRichContent | string
O conteúdo do comentário. Isto pode ser uma cadeia ou CommentRichContent objeto. As cadeias são utilizadas para texto simples.
CommentRichContent os objetos permitem outras funcionalidades de comentários, como menções. [Conjunto de API: ExcelApi 1.10 para cadeia, 1.11 para o objeto CommentRichContent]
- contentTypeString
-
"Plain" | "Mention"
Opcional. O tipo de conteúdo contido no comentário. O valor predefinido é enum 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 comentários na coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
getItem(commentId)
Obtém um comentário da coleção com base em seu ID.
getItem(commentId: string): Excel.Comment;Parâmetros
- commentId
-
string
O identificador do comentário.
Retornos
Comentários
getItemAt(index)
Obtém um comentário da coleção com base em sua posição.
getItemAt(index: number): Excel.Comment;Parâmetros
- index
-
number
Valor de índice do objeto a ser recuperado. Indexados com zero.
Retornos
Comentários
getItemByCell(cellAddress)
Obtém o comentário da célula especificada. Se não existir nenhum comentário na célula, é gerado um erro.
getItemByCell(cellAddress: Range | string): Excel.Comment;Parâmetros
- cellAddress
-
Excel.Range | string
A célula na qual o comentário se encontra. Pode ser um Range objeto ou uma cadeia. Se for uma cadeia, tem de conter o endereço completo, incluindo o nome da folha. É InvalidArgument apresentado um erro se o intervalo fornecido for maior do que uma célula.
Retornos
Comentários
getItemByReplyId(replyId)
Obtém o comentário ao qual a resposta especificada está ligada.
getItemByReplyId(replyId: string): Excel.Comment;Parâmetros
- replyId
-
string
O identificador da resposta a comentários.
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.CommentCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentCollection;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[]): Excel.CommentCollection;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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.CommentCollection;Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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 Excel.CommentCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.CommentCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.CommentCollectionData;