MAIDR JavaScript API
    Preparing search index...

    Interface OfficeSettings

    An add-in's settings (Office.Settings; Settings requirement set): each instance of the add-in has its own, saved in the document. A value is anything JSON can hold.

    interface OfficeSettings {
        get: (name: string) => unknown;
        set: (name: string, value: unknown) => void;
        remove: (name: string) => void;
        saveAsync: (callback?: (result: OfficeAsyncResult<void>) => void) => void;
    }
    Index

    Properties

    get set remove saveAsync

    Properties

    get: (name: string) => unknown

    A setting's value; null or undefined when it is not set.

    set: (name: string, value: unknown) => void

    Set a setting, until the add-in closes; saveAsync keeps it.

    remove: (name: string) => void
    saveAsync: (callback?: (result: OfficeAsyncResult<void>) => void) => void

    Save the settings in the document, to be saved with it.

    Settings

    Member Visibility

    On This Page

    Properties