Edit

Share via


Word.Interfaces.WebSettingsLoadOptions interface

Represents the settings for saving a Word document as a webpage.

Remarks

[ API set: WordApiDesktop 1.4 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

allowPng

Specifies whether PNG is allowed as an image format when saving a document as a webpage. Default is false.

encoding

Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document.

folderSuffix

Gets the folder suffix used when saving a document as a webpage with long file names and supporting files in a separate folder.

organizeInFolder

Specifies whether supporting files are organized in a separate folder when saving the document as a webpage. Default is true.

pixelsPerInch

Specifies the density (pixels per inch) of graphics images and table cells on a webpage.

relyOnCSS

Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser. Default is true.

relyOnVectorMarkupLanguage

Specifies whether image files are not generated from drawing objects when saving a document as a webpage. Default is false.

screenSize

Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser.

targetBrowser

Specifies the target browser for documents viewed in a web browser.

useLongFileNames

Specifies whether long file names are used when saving the document as a webpage. Default is true.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

allowPng

Specifies whether PNG is allowed as an image format when saving a document as a webpage. Default is false.

allowPng?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

encoding

Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document.

encoding?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

folderSuffix

Gets the folder suffix used when saving a document as a webpage with long file names and supporting files in a separate folder.

folderSuffix?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

organizeInFolder

Specifies whether supporting files are organized in a separate folder when saving the document as a webpage. Default is true.

organizeInFolder?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

pixelsPerInch

Specifies the density (pixels per inch) of graphics images and table cells on a webpage.

pixelsPerInch?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

relyOnCSS

Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser. Default is true.

relyOnCSS?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

relyOnVectorMarkupLanguage

Specifies whether image files are not generated from drawing objects when saving a document as a webpage. Default is false.

relyOnVectorMarkupLanguage?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

screenSize

Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser.

screenSize?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

targetBrowser

Specifies the target browser for documents viewed in a web browser.

targetBrowser?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

useLongFileNames

Specifies whether long file names are used when saving the document as a webpage. Default is true.

useLongFileNames?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]