Excel.WorksheetCustomPropertyCollection class
Contém a coleção de propriedades personalizadas de nível de planilha.
- Extends
Comentários
[Conjunto de apis: ExcelApi 1.12]
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(key, value) | Adiciona uma nova propriedade personalizada que mapeia para a chave fornecida. Isso substitui as propriedades personalizadas existentes por essa chave. |
| get |
Obtém o número de propriedades personalizadas nesta planilha. |
| get |
Obtém um objeto de propriedade personalizada por sua chave, que diferencia maiúsculas de minúsculas. Gera um erro se a propriedade personalizada não existir. |
| get |
Obtém um objeto de propriedade personalizada por sua chave, que diferencia maiúsculas de minúsculas. Se a propriedade personalizada 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.WorksheetCustomProperty[];Valor da propriedade
Detalhes do método
add(key, value)
Adiciona uma nova propriedade personalizada que mapeia para a chave fornecida. Isso substitui as propriedades personalizadas existentes por essa chave.
add(key: string, value: string): Excel.WorksheetCustomProperty;Parâmetros
- key
-
string
A chave que identifica o objeto de propriedade personalizada. Não diferencia maiúsculas de minúsculas. A chave é limitada a 255 caracteres (valores maiores farão com que um InvalidArgument erro seja gerado).
- value
-
string
O valor dessa propriedade personalizada.
Retornos
Comentários
[Conjunto de apis: ExcelApi 1.12]
getCount()
Obtém o número de propriedades personalizadas nesta planilha.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
[Conjunto de apis: ExcelApi 1.12]
getItem(key)
Obtém um objeto de propriedade personalizada por sua chave, que diferencia maiúsculas de minúsculas. Gera um erro se a propriedade personalizada não existir.
getItem(key: string): Excel.WorksheetCustomProperty;Parâmetros
- key
-
string
A chave que identifica o objeto de propriedade personalizada. Não diferencia maiúsculas de minúsculas.
Retornos
Comentários
[Conjunto de apis: ExcelApi 1.12]
getItemOrNullObject(key)
Obtém um objeto de propriedade personalizada por sua chave, que diferencia maiúsculas de minúsculas. Se a propriedade personalizada 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(key: string): Excel.WorksheetCustomProperty;Parâmetros
- key
-
string
A chave que identifica o objeto de propriedade personalizada. Não diferencia maiúsculas de minúsculas.
Retornos
Comentários
[Conjunto de apis: ExcelApi 1.12]
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.WorksheetCustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCustomPropertyCollection;Parâmetros
- options
-
Excel.Interfaces.WorksheetCustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
Fornece opções para quais propriedades do objeto devem ser carregadas.
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.WorksheetCustomPropertyCollection;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica 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.WorksheetCustomPropertyCollection;Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula 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.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.WorksheetCustomPropertyCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.WorksheetCustomPropertyCollectionData) que contém uma matriz "items" com cópias superficiais de todas as propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.WorksheetCustomPropertyCollectionData;