PowerPoint.CustomXmlPartScopedCollection class
Uma coleção com escopo de partes XML personalizadas. Uma coleção com escopo é o resultado de alguma operação (como a filtragem por namespace). Não é possível ter mais escopo de uma coleção com escopo.
- 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
| get |
Obtém o número de partes 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 de um item, esse método retornará o |
| get |
Se o conjunto contiver exatamente um item, esse método o retornará. Caso contrário, esse método retornará |
| 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.CustomXmlPart[];Valor da propriedade
Detalhes do método
getCount()
Obtém o número de partes XML personalizadas nesta coleção.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
O número de partes XML personalizadas na coleção.
Comentários
getItem(id)
Obtém um CustomXmlPart com base em sua ID.
getItem(id: string): PowerPoint.CustomXmlPart;Parâmetros
- id
-
string
ID do objeto a ser recuperado.
Retornos
Comentários
getItemAt(index)
Obtém um CustomXmlPart 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.CustomXmlPart;Parâmetros
- index
-
number
O índice da parte XML personalizada na coleção.
Retornos
A parte XML personalizada no índice fornecido.
Comentários
getItemOrNullObject(id)
Obtém um CustomXmlPart com base em sua ID. Se o CustomXmlPart 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(id: string): PowerPoint.CustomXmlPart;Parâmetros
- id
-
string
ID do objeto a ser recuperado.
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 de um item, esse método retornará 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, esse método retornará 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 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.CustomXmlPartScopedCollection;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.CustomXmlPartScopedCollection;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.CustomXmlPartScopedCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.CustomXmlPartScopedCollectionData) que contém uma matriz "items" com cópias superficiais de todas as propriedades carregadas dos itens da coleção.
toJSON(): PowerPoint.Interfaces.CustomXmlPartScopedCollectionData;