Excel.NoteCollection class
Representa uma coleção de objetos de nota que fazem parte do livro.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.18 ]
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 |
Adiciona uma nova nota com o conteúdo especificado na célula especificada. |
| get |
Obtém o número de notas na coleção. |
| get |
Obtém uma nota pelo respetivo endereço de célula. |
| get |
Obtém uma nota da coleção com base na sua posição. |
| get |
Obtém uma nota pelo respetivo endereço de célula. Se o objeto de nota não existir, este método devolve um objeto com a respetiva |
| 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.Note[];Valor da propriedade
Detalhes do método
add(cellAddress, content)
Adiciona uma nova nota com o conteúdo especificado na célula especificada.
add(cellAddress: Range | string, content: any): Excel.Note;Parâmetros
- cellAddress
-
Excel.Range | string
A célula à qual a nota é adicionada. Pode ser um Range objeto ou uma cadeia, como "A1". Se a cadeia for inválida ou o intervalo não for uma única célula, é gerado um InvalidCellAddress erro.
- content
-
any
O texto da nota.
Retornos
Comentários
getCount()
Obtém o número de notas na coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
getItem(key)
Obtém uma nota pelo respetivo endereço de célula.
getItem(key: string): Excel.Note;Parâmetros
- key
-
string
O endereço da célula da nota.
Retornos
A nota com o endereço de célula especificado. Se não existir nenhuma nota com o endereço de célula especificado, é gerado o ItemNotFound erro.
Comentários
getItemAt(index)
Obtém uma nota da coleção com base na sua posição.
getItemAt(index: number): Excel.Note;Parâmetros
- index
-
number
O valor de índice da nota a obter. Indexados com zero.
Retornos
Comentários
getItemOrNullObject(key)
Obtém uma nota pelo respetivo endereço de célula. Se o objeto de nota não existir, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getItemOrNullObject(key: string): Excel.Note;Parâmetros
- key
-
string
O endereço da célula da nota.
Retornos
A nota com o endereço de célula especificado ou objeto nulo.
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.NoteCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NoteCollection;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.NoteCollection;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.NoteCollection;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.NoteCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.NoteCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.NoteCollectionData;