PowerPoint.CustomXmlPartScopedCollection class
Uma coleção no âmbito de peças XML personalizadas. Uma coleção no âmbito é o resultado de alguma operação (como filtrar por espaço de nomes). Uma coleção no âmbito não pode ser confinada mais.
- 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
| get |
Obtém o número de peças XML personalizadas nesta coleção. |
| get |
Obtém um |
| get |
Obtém um |
| get |
Obtém um |
| get |
Se o conjunto contiver exatamente um item, esse método o retornará. Se a coleção não contiver itens ou mais do que um item, este método devolve o |
| get |
Se o conjunto contiver exatamente um item, esse método o retornará. Caso contrário, este método devolve |
| 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.CustomXmlPart[];Valor da propriedade
Detalhes do método
getCount()
Obtém o número de peças XML personalizadas nesta coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
O número de peças XML personalizadas na coleção.
Comentários
getItem(id)
Obtém um CustomXmlPart com base no respetivo ID.
getItem(id: string): PowerPoint.CustomXmlPart;Parâmetros
- id
-
string
ID do objeto a obter.
Retornos
Comentários
getItemAt(index)
Obtém um CustomXmlPart 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.CustomXmlPart;Parâmetros
- index
-
number
O índice da peça XML personalizada na coleção.
Retornos
A parte XML personalizada no índice especificado.
Comentários
getItemOrNullObject(id)
Obtém um CustomXmlPart com base no respetivo ID. Se o não existir, este método devolve um objeto com a CustomXmlPart respetiva propriedade definida como true.isNullObject Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getItemOrNullObject(id: string): PowerPoint.CustomXmlPart;Parâmetros
- id
-
string
ID do objeto a obter.
Retornos
Comentários
getOnlyItem()
Se o conjunto contiver exatamente um item, esse método o retornará. Se a coleção não contiver itens ou mais do que um item, este método devolve o GeneralException erro.
getOnlyItem(): PowerPoint.CustomXmlPart;Retornos
Comentários
getOnlyItemOrNullObject()
Se o conjunto contiver exatamente um item, esse método o retornará. Caso contrário, este método devolve null.
getOnlyItemOrNullObject(): PowerPoint.CustomXmlPart;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.CustomXmlPartScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomXmlPartScopedCollection;Parâmetros
- options
-
PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions & 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.CustomXmlPartScopedCollection;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.CustomXmlPartScopedCollection;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.CustomXmlPartScopedCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.CustomXmlPartScopedCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): PowerPoint.Interfaces.CustomXmlPartScopedCollectionData;