Edit

Word.TableOfAuthoritiesMarkCitationOptions interface

Specifies the options for inserting a Table of Authorities Entry (TA) field.

Remarks

API set: WordApiDesktop 1.4

Used by

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/42-reference-tables/table-of-authorities.yaml

// Marks each matching case name as a citation.
await Word.run(async (context) => {
    const tablesOfAuthorities: Word.TableOfAuthoritiesCollection = context.document.tablesOfAuthorities;
    const citationOptions: Word.TableOfAuthoritiesMarkCitationOptions = {
        category: 1,
        longCitation: "Contoso v. Fabrikam, 2026",
    };
    tablesOfAuthorities.markAllCitations("Contoso v. Fabrikam", citationOptions);
    await context.sync();

    console.log("Marked every occurrence of Contoso v. Fabrikam as a citation.");
});

Properties

category

If provided, specifies the category number to be associated with the entry. Values 1 through 16 correspond to the items listed in the Category dropdown list of the Mark Citation dialog. The value 1 corresponds to the first category listed, 2 corresponds to the second category, and so on. To learn how to access this through the Word UI, see Create a table of authorities.

longCitation

If provided, specifies the long citation for the entry as it will appear in a table of authorities.

longCitationAutoText

If provided, specifies the name of the AutoText entry that contains the text of the long citation as it will appear in a table of authorities.

Property Details

category

If provided, specifies the category number to be associated with the entry. Values 1 through 16 correspond to the items listed in the Category dropdown list of the Mark Citation dialog. The value 1 corresponds to the first category listed, 2 corresponds to the second category, and so on. To learn how to access this through the Word UI, see Create a table of authorities.

category?: number;

Property Value

number

Remarks

API set: WordApiDesktop 1.4

longCitation

If provided, specifies the long citation for the entry as it will appear in a table of authorities.

longCitation?: string;

Property Value

string

Remarks

API set: WordApiDesktop 1.4

longCitationAutoText

If provided, specifies the name of the AutoText entry that contains the text of the long citation as it will appear in a table of authorities.

longCitationAutoText?: string;

Property Value

string

Remarks

API set: WordApiDesktop 1.4