PowerPoint.CustomPropertyCollection class
Uma coleção de propriedades personalizadas.
- Extends
Comentários
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(key, value) | Cria um novo |
| delete |
Exclui todas as propriedades personalizadas nesta coleção. |
| get |
Obtém o número de propriedades personalizadas na coleção. |
| get |
Obtém um |
| get |
Obtém um |
| get |
Obtém 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 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: PowerPoint.CustomProperty[];Valor da propriedade
Detalhes do método
add(key, value)
Cria um novo CustomProperty ou atualiza a propriedade com a chave especificada.
add(key: string, value: boolean | Date | number | string): PowerPoint.CustomProperty;Parâmetros
- key
-
string
A cadeia que identifica o CustomProperty objeto. Não é sensível a maiúsculas e minúsculas. O comprimento máximo da chave é de 255 carateres. Cadeias maiores fazem com que a operação falhe com um InvalidArgument erro.
- value
-
boolean | Date | number | string
O valor de CustomProperty. Se o valor for uma cadeia, o comprimento máximo é de 255 carateres. Cadeias 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)
Obtém um CustomProperty pela chave.
getItem(key: string): PowerPoint.CustomProperty;Parâmetros
- key
-
string
A cadeia que identifica o CustomProperty objeto. Não é sensível a maiúsculas e minúsculas. As teclas têm um comprimento máximo de 255 carateres. Se o argumento exceder os 255 carateres, este método devolve o InvalidArgument erro.
Retornos
Comentários
getItemAt(index)
Obtém um CustomProperty pelo respetivo índice baseado em zero na coleção. Gera uma exceção InvalidArgument 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 personalizada no índice especificado.
Comentários
getItemOrNullObject(key)
Obtém um CustomProperty pela chave. Se o não existir, este método devolve um objeto com a CustomProperty respetiva propriedade definida como true.isNullObject Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getItemOrNullObject(key: string): PowerPoint.CustomProperty;Parâmetros
- key
-
string
A cadeia que identifica o CustomProperty objeto. Não é sensível a maiúsculas e minúsculas. As teclas têm um comprimento máximo de 255 carateres. Se o argumento exceder os 255 carateres, este método devolve 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 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[]): PowerPoint.CustomPropertyCollection;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): PowerPoint.CustomPropertyCollection;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 PowerPoint.CustomPropertyCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.CustomPropertyCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): PowerPoint.Interfaces.CustomPropertyCollectionData;