Edit

Share via


Word.Interfaces.PageData interface

An interface describing the data returned by calling page.toJSON().

Properties

breaks

Gets a BreakCollection object that represents the breaks on the page.

height

Gets the height, in points, of the paper defined in the Page Setup dialog box.

index

Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering.

width

Gets the width, in points, of the paper defined in the Page Setup dialog box.

Property Details

breaks

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets a BreakCollection object that represents the breaks on the page.

breaks?: Word.Interfaces.BreakData[];

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

height

Gets the height, in points, of the paper defined in the Page Setup dialog box.

height?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.2 ]

index

Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering.

index?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.2 ]

width

Gets the width, in points, of the paper defined in the Page Setup dialog box.

width?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.2 ]