SheetXL - v1.0.2
    Preparing search index...

    Interface IDocumentProperties

    Information about the workbook as a document: who wrote it, what it is about, when it was created. Saved with the workbook; none of it affects calculation or display.

    Shaped after Office Scripts' DocumentProperties. Every value is null when the workbook does not have one. A value read from a file is kept as it was, so saving a workbook does not change who created it or when.

    IWorkbook.getProperties

    interface IDocumentProperties {
        addCustomProperty(
            key: string,
            value: string | number | boolean | Date,
        ): ICustomProperty;
        deleteAllCustomProperties(): void;
        getAuthor(): string | null;
        getCategory(): string | null;
        getComments(): string | null;
        getCompany(): string | null;
        getContentStatus(): string | null;
        getCreationDate(): Date | null;
        getCustom(): ICustomProperty[];
        getCustomProperty(key: string): ICustomProperty | undefined;
        getKeywords(): string | null;
        getLastAuthor(): string | null;
        getManager(): string | null;
        getRevisionNumber(): number | null;
        getSubject(): string | null;
        getTitle(): string | null;
        setAuthor(author: string | null): this;
        setCategory(category: string | null): this;
        setComments(comments: string | null): this;
        setCompany(company: string | null): this;
        setContentStatus(contentStatus: string | null): this;
        setKeywords(keywords: string | null): this;
        setManager(manager: string | null): this;
        setRevisionNumber(revisionNumber: number | null): this;
        setSubject(subject: string | null): this;
        setTitle(title: string | null): this;
        toJSON(): IDocumentProperties.JSON;
    }
    Index
    addCustomProperty deleteAllCustomProperties getAuthor getCategory getComments getCompany getContentStatus getCreationDate getCustom getCustomProperty getKeywords getLastAuthor getManager getRevisionNumber getSubject getTitle setAuthor setCategory setComments setCompany setContentStatus setKeywords setManager setRevisionNumber setSubject setTitle toJSON

    • Adds a custom property, or sets the value of the one already named key (ignoring case).

      Parameters

      • key: string

        The property's name. Not empty.

      • value: string | number | boolean | Date

        The property's value; its type follows ICustomProperty.setValue.

      Returns ICustomProperty

    • Removes every custom property.

      Returns void

    • The author of the workbook.

      Returns string | null

    • A category for the workbook, such as Invoices.

      Returns string | null

    • A description of the workbook's content.

      Returns string | null

    • The company the workbook belongs to.

      Returns string | null

    • The status of the workbook, such as Draft or Final.

      Returns string | null

    • When the workbook was created.

      Returns Date | null

      Read-only. A workbook that has none is stamped with the time it is first saved.

    • The custom property named key, ignoring case, or undefined if there is none.

      Parameters

      • key: string

      Returns ICustomProperty | undefined

    • Keywords that describe the workbook.

      Returns string | null

    • Who last saved the workbook, as the file it was read from says.

      Returns string | null

      Read-only.

    • The manager of the workbook's author.

      Returns string | null

    • The workbook's revision number.

      Returns number | null

    • The subject of the workbook.

      Returns string | null

    • The title of the workbook.

      Returns string | null

    • Sets getAuthor.

      Parameters

      • author: string | null

      Returns this

    • Sets getCategory.

      Parameters

      • category: string | null

      Returns this

    • Sets getComments.

      Parameters

      • comments: string | null

      Returns this

    • Sets getCompany.

      Parameters

      • company: string | null

      Returns this

    • Sets getContentStatus.

      Parameters

      • contentStatus: string | null

      Returns this

    • Sets getKeywords.

      Parameters

      • keywords: string | null

      Returns this

    • Sets getManager.

      Parameters

      • manager: string | null

      Returns this

    • Sets getRevisionNumber.

      Parameters

      • revisionNumber: number | null

      Returns this

    • Sets getSubject.

      Parameters

      • subject: string | null

      Returns this

    • Sets getTitle.

      Parameters

      • title: string | null

      Returns this

    Settings
    Member Visibility

    On This Page
    Methods