OneNote.FloatingInk class

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

Obtém a ID do objeto FloatingInk.

readonly id: string;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Obtém os traços do objeto FloatingInk.

readonly inkStrokes: OneNote.InkStrokeCollection;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

Obtém o pai de PageContent do objeto FloatingInk.

readonly pageContent: OneNote.PageContent;

Valor da propriedade

Comentários

[ Conjunto de API: OneNoteApi 1.1 ]

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.FloatingInkLoadOptions): OneNote.FloatingInk;

Parâmetros

Retornos

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.FloatingInk;

Parâmetros

Retornos

Exemplos

await OneNote.run(async (context) => {

    // Gets the active page.
    const page = context.application.getActivePage();
    const contents = page.contents;
    
    // Load page contents and their types.
    page.load('contents/type');
    await context.sync();
        
    // Load every ink content.
    $.each(contents.items, function(i, content) {
        if (content.type == "Ink")
        {
            content.load('ink/id');
        }                            
    });
    await context.sync();
        
    // Log ID of every ink content.
    $.each(contents.items, function(i, content) {
        if (content.type == "Ink")
        {
            console.log(content.ink.id);
        }                            
    });           
});

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): OneNote.FloatingInk;

Parâmetros

Retornos

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.FloatingInk é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como OneNote.Interfaces.FloatingInkData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): OneNote.Interfaces.FloatingInkData;

Retornos

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.FloatingInk;

Retornos

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.FloatingInk;

Retornos