OneNote.SectionGroupCollection class
Representa um conjunto de grupo de seções.
- Extends
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
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. |
| count | Retorna a quantidade de grupos de seções no conjunto. |
| items | Obtém os itens filhos carregados nesta coleção. |
Métodos
| get |
Obtém o conjunto de grupos de seções com o nome especificado. |
| get |
Obtém um grupo de seção pela ID ou pelo índice na coleção. Somente leitura. |
| get |
Obtém um grupo de seção na posição dele no conjunto. |
| 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 |
| track() | Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre |
| untrack() | Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar |
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
count
Retorna a quantidade de grupos de seções no conjunto.
readonly count: number;Valor da propriedade
number
Comentários
items
Obtém os itens filhos carregados nesta coleção.
readonly items: OneNote.SectionGroup[];Valor da propriedade
Detalhes do método
getByName(name)
Obtém o conjunto de grupos de seções com o nome especificado.
getByName(name: string): OneNote.SectionGroupCollection;Parâmetros
- name
-
string
O nome do grupo de seção.
Retornos
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
Exemplos
await OneNote.run(async (context) => {
// Get the section groups that are direct children of the current notebook.
const sectionGroups = context.application.getActiveNotebook().sectionGroups;
// Queue a command to load the section groups.
// For best performance, request specific properties.
sectionGroups.load("id");
// Get the section groups with the specified name.
const labsSectionGroups = sectionGroups.getByName("Labs");
// Queue a command to load the section groups with the specified properties.
labsSectionGroups.load("id,name");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Iterate through the collection or access items individually by index.
if (labsSectionGroups.items.length > 0) {
console.log("Section group name: " + labsSectionGroups.items[0].name);
console.log("Section group ID: " + labsSectionGroups.items[0].id);
}
});
getItem(index)
Obtém um grupo de seção pela ID ou pelo índice na coleção. Somente leitura.
getItem(index: number | string): OneNote.SectionGroup;Parâmetros
- index
-
number | string
A ID do grupo de seção ou a localização do índice do grupo de seção na coleção.
Retornos
Comentários
getItemAt(index)
Obtém um grupo de seção na posição dele no conjunto.
getItemAt(index: number): OneNote.SectionGroup;Parâmetros
- index
-
number
Valor de índice do objeto a ser recuperado. Indexados com zero.
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?: OneNote.Interfaces.SectionGroupCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.SectionGroupCollection;Parâmetros
- options
-
OneNote.Interfaces.SectionGroupCollectionLoadOptions & OneNote.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[]): OneNote.SectionGroupCollection;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
Exemplos
await OneNote.run(async (context) => {
// Get the section groups that are direct children of the current notebook.
const sectionGroups = context.application.getActiveNotebook().sectionGroups;
// Queue a command to load the section groups.
// For best performance, request specific properties.
sectionGroups.load("name");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Iterate through the collection or access items individually by index.
// For example: sectionGroups.items[0]
$.each(sectionGroups.items, function(index, sectionGroup) {
console.log("Section group name: " + sectionGroup.name);
console.log("Section group ID: " + sectionGroup.id);
});
});
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): OneNote.SectionGroupCollection;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 OneNote.SectionGroupCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como OneNote.Interfaces.SectionGroupCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): OneNote.Interfaces.SectionGroupCollectionData;Retornos
track()
Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez.
track(): OneNote.SectionGroupCollection;Retornos
untrack()
Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.
untrack(): OneNote.SectionGroupCollection;