PowerPoint.CustomPropertyCollection class
Uma coleção de propriedades personalizadas.
- Extends
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) | Cria uma nova |
| delete |
Exclui todas as propriedades personalizadas nesta coleção. |
| get |
Obtém o número de propriedades personalizadas na coleção. |
| get |
Recebe um |
| get |
Obtém um |
| get |
Recebe um |
| 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: PowerPoint.CustomProperty[];Valor da propriedade
Detalhes do método
add(key, value)
Cria uma nova CustomProperty propriedade ou atualiza a propriedade com a chave fornecida.
add(key: string, value: boolean | Date | number | string): PowerPoint.CustomProperty;Parâmetros
- key
-
string
A cadeia de caracteres que identifica o CustomProperty objeto. Não diferencia maiúsculas de minúsculas. O comprimento máximo da chave é de 255 caracteres. Cadeias de caracteres maiores fazem com que a operação falhe com um InvalidArgument erro.
- value
-
boolean | Date | number | string
O valor do CustomProperty. Se o valor for uma cadeia de caracteres, o comprimento máximo será de 255 caracteres. Cadeias de caracteres maiores fazem com que a operação falhe com um InvalidArgument erro.
Retornos
Comentários
deleteAll()
Exclui todas as propriedades personalizadas nesta coleção.
deleteAll(): void;Retornos
void
Comentários
getCount()
Obtém o número de propriedades personalizadas na coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
O número de propriedades personalizadas na coleção.
Comentários
getItem(key)
Recebe um CustomProperty por sua chave.
getItem(key: string): PowerPoint.CustomProperty;Parâmetros
- key
-
string
A cadeia de caracteres que identifica o CustomProperty objeto. Não diferencia maiúsculas de minúsculas. As chaves têm um comprimento máximo de 255 caracteres. Se o argumento exceder 255 caracteres, esse método retornará o InvalidArgument erro.
Retornos
Comentários
getItemAt(index)
Obtém um CustomProperty por seu índice baseado em zero na coleção. Lança uma InvalidArgument exceção quando o índice está fora do intervalo.
getItemAt(index: number): PowerPoint.CustomProperty;Parâmetros
- index
-
number
O índice da propriedade personalizada na coleção.
Retornos
A propriedade customizada no índice fornecido.
Comentários
getItemOrNullObject(key)
Recebe um CustomProperty por sua chave. Se o CustomProperty 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): PowerPoint.CustomProperty;Parâmetros
- key
-
string
A cadeia de caracteres que identifica o CustomProperty objeto. Não diferencia maiúsculas de minúsculas. As chaves têm um comprimento máximo de 255 caracteres. Se o argumento exceder 255 caracteres, esse método retornará o InvalidArgument erro.
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?: PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomPropertyCollection;Parâmetros
- options
-
PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions & PowerPoint.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[]): PowerPoint.CustomPropertyCollection;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): PowerPoint.CustomPropertyCollection;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 PowerPoint.CustomPropertyCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.CustomPropertyCollectionData) que contém uma matriz "items" com cópias superficiais de todas as propriedades carregadas dos itens da coleção.
toJSON(): PowerPoint.Interfaces.CustomPropertyCollectionData;