Word.TableOfContentsMarkEntryOptions interface

Paquete:
word

Especifica las opciones para insertar un campo de entrada de tabla de contenido (TC).

Comentarios

Conjunto de API: WordApiDesktop 1.4

Usada por

Ejemplos

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

// Marks each figure paragraph as a table entry.
await Word.run(async (context) => {
    const documentBody: Word.Body = context.document.body;
    const tablesOfFigures: Word.TableOfFiguresCollection = context.document.tablesOfFigures;
    const paragraphs: Word.ParagraphCollection = documentBody.paragraphs;
    paragraphs.load("items/text");
    await context.sync();

    const figureParagraphs: Word.Paragraph[] = paragraphs.items.filter((paragraph: Word.Paragraph) =>
        paragraph.text.startsWith("Figure ")
    );
    figureParagraphs.forEach((figureParagraph: Word.Paragraph) => {
        const entryOptions: Word.TableOfContentsMarkEntryOptions = {
            entry: figureParagraph.text,
            level: 1,
            tableId: "F",
        };
        const entryRange: Word.Range = figureParagraph.getRange();
        tablesOfFigures.markTocEntry(entryRange, entryOptions);
    });
    await context.sync();

    console.log(`Marked ${figureParagraphs.length} table of figures entries.`);
});

Propiedades

entry

Si se proporciona, especifica el texto que aparece en una tabla de contenido o una tabla de ilustraciones. Para indicar una subentrada, incluya el texto de la entrada principal y el texto de la subentrada, separados por dos puntos (":") (por ejemplo, "Introducción: el producto"). Cuando se establece la entryAutoText propiedad, esta propiedad se omite.
entryAutoText

Si se proporciona, especifica el nombre de la entrada de Autotexto que incluye texto para la tabla de ilustraciones o la tabla de contenido. Cuando se utiliza esta propiedad, se entry omite.
level

Si se proporciona, especifica el nivel para la entrada en una tabla de contenido o una tabla de ilustraciones y debe ser un valor de 1 a 9.
tableId

Si se proporciona, especifica un identificador de una letra para una tabla de contenido o una tabla de ilustraciones (por ejemplo, "i" para una "ilustración").

Detalles de las propiedades

entry

Si se proporciona, especifica el texto que aparece en una tabla de contenido o una tabla de ilustraciones. Para indicar una subentrada, incluya el texto de la entrada principal y el texto de la subentrada, separados por dos puntos (":") (por ejemplo, "Introducción: el producto"). Cuando se establece la entryAutoText propiedad, esta propiedad se omite.

entry?: string;

Valor de propiedad

string

Comentarios

Conjunto de API: WordApiDesktop 1.4

entryAutoText

Si se proporciona, especifica el nombre de la entrada de Autotexto que incluye texto para la tabla de ilustraciones o la tabla de contenido. Cuando se utiliza esta propiedad, se entry omite.

entryAutoText?: string;

Valor de propiedad

string

Comentarios

Conjunto de API: WordApiDesktop 1.4

level

Si se proporciona, especifica el nivel para la entrada en una tabla de contenido o una tabla de ilustraciones y debe ser un valor de 1 a 9.

level?: number;

Valor de propiedad

number

Comentarios

Conjunto de API: WordApiDesktop 1.4

tableId

Si se proporciona, especifica un identificador de una letra para una tabla de contenido o una tabla de ilustraciones (por ejemplo, "i" para una "ilustración").

tableId?: string;

Valor de propiedad

string

Comentarios

Conjunto de API: WordApiDesktop 1.4