Word.WebSettings class

表示将 Word 文档另存为网页的设置。

注解

使用方

Word.文档： webSettings

属性

allowPng	指定将文档另存为网页时是否允许 PNG 作为图像格式。默认值为 `false`。
context	与对象关联的请求上下文。这将加载项的进程连接到 Office 主机应用程序的进程。
encoding	指定在查看保存的文档时，Web 浏览器要使用的文档编码 (代码页或字符集) 。
folderSuffix	获取将文档另存为具有长文件名和支持文件的网页时使用的文件夹后缀。
organizeInFolder	指定将文档另存为网页时，是否将支持文件组织在单独的文件夹中。默认值为 `true`。
pixelsPerInch	指定网页上图形图像和表格单元格) 的密度 (每英寸像素。
relyOnCSS	指定在 Web 浏览器中查看保存的文档时，是否将级联样式表 (CSS) 用于字体格式。默认值为 `true`。
relyOnVectorMarkupLanguage	指定将文档另存为网页时是否不从图形对象生成图像文件。默认值为 `false`。
screenSize	指定在 Web 浏览器中查看保存的文档的理想最小屏幕大小 (宽度按高度) 像素。
targetBrowser	指定在 Web 浏览器中查看的文档的目标浏览器。
useLongFileNames	指定将文档另存为网页时是否使用长文件名。默认值为 `true`。

方法

load(options)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNames)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
toJSON()	覆盖 JavaScript `toJSON()` 方法，以便在将 API 对象传递给 `JSON.stringify()`时提供更有用的输出。 (`JSON.stringify`反过来调用 `toJSON` 传递给它的对象的方法。) 虽然原始 `Word.WebSettings` 对象是 API 对象， `toJSON` 但该方法返回一个纯 JavaScript 对象， (类型化为 `Word.Interfaces.WebSettingsData`) ，其中包含从原始对象加载的任何子属性的浅层副本。
track()	根据文档中的相应更改来跟踪对象，以便进行自动调整。此调用是 context.trackedObjects.add (thisObject) 的简写。如果在调用中 `.sync` 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。如果此对象是集合的一部分，您还应跟踪父集合。
untrack()	释放与此对象关联的内存（如果先前已跟踪过）。此调用是 context.trackedObjects.remove (thisObject) 的简写。拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。需要在内存释放生效之前调用 `context.sync()` 。
useDefaultFolderSuffix()	根据选定或安装的语言，将含指定文档的文件夹后缀设置为默认后缀。

allowPng

指定将文档另存为网页时是否允许 PNG 作为图像格式。默认值为 false。

allowPng: boolean;

属性值

boolean

注解

API 集：WordApiDesktop 1.4

context

与对象关联的请求上下文。这将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Word.RequestContext

encoding

指定在查看保存的文档时，Web 浏览器要使用的文档编码 (代码页或字符集) 。

encoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";

属性值

注解

API 集：WordApiDesktop 1.4

folderSuffix

获取将文档另存为具有长文件名和支持文件的网页时使用的文件夹后缀。

readonly folderSuffix: string;

属性值

string

注解

API 集：WordApiDesktop 1.4

organizeInFolder

指定将文档另存为网页时，是否将支持文件组织在单独的文件夹中。默认值为 true。

organizeInFolder: boolean;

属性值

boolean

注解

API 集：WordApiDesktop 1.4

pixelsPerInch

指定网页上图形图像和表格单元格) 的密度 (每英寸像素。

pixelsPerInch: number;

属性值

number

注解

API 集：WordApiDesktop 1.4

relyOnCSS

指定在 Web 浏览器中查看保存的文档时，是否将级联样式表 (CSS) 用于字体格式。默认值为 true。

relyOnCSS: boolean;

属性值

boolean

注解

API 集：WordApiDesktop 1.4

relyOnVectorMarkupLanguage

指定将文档另存为网页时是否不从图形对象生成图像文件。默认值为 false。

relyOnVectorMarkupLanguage: boolean;

属性值

boolean

注解

API 集：WordApiDesktop 1.4

screenSize

指定在 Web 浏览器中查看保存的文档的理想最小屏幕大小 (宽度按高度) 像素。

screenSize: Word.ScreenSize | "Size544x376" | "Size640x480" | "Size720x512" | "Size800x600" | "Size1024x768" | "Size1152x882" | "Size1152x900" | "Size1280x1024" | "Size1600x1200" | "Size1800x1440" | "Size1920x1200";

属性值

注解

API 集：WordApiDesktop 1.4

targetBrowser

指定在 Web 浏览器中查看的文档的目标浏览器。

targetBrowser: Word.TargetBrowser | "V3" | "V4" | "Ie4" | "Ie5" | "Ie6";

属性值

Word.TargetBrowser | "V3" | "V4" | "Ie4" | "Ie5" | "Ie6"

注解

API 集：WordApiDesktop 1.4

useLongFileNames

指定将文档另存为网页时是否使用长文件名。默认值为 true。

useLongFileNames: boolean;

属性值

boolean

注解

API 集：WordApiDesktop 1.4

load(options)

将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 context.sync()。

load(options?: Word.Interfaces.WebSettingsLoadOptions): Word.WebSettings;

参数

options: Word.Interfaces.WebSettingsLoadOptions

为要加载的对象属性提供选项。

返回

Word.WebSettings

load(propertyNames)

将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): Word.WebSettings;

参数

propertyNames: string | string[]

指定要加载的属性的逗号分隔的字符串或字符串数组。

返回

Word.WebSettings

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.WebSettings;

参数

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。

返回

Word.WebSettings

toJSON()

覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Word.WebSettings 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Word.Interfaces.WebSettingsData) ，其中包含从原始对象加载的任何子属性的浅层副本。

toJSON(): Word.Interfaces.WebSettingsData;

返回

Word.Interfaces.WebSettingsData

track()

根据文档中的相应更改来跟踪对象，以便进行自动调整。此调用是 context.trackedObjects.add (thisObject) 的简写。如果在调用中 .sync 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。如果此对象是集合的一部分，您还应跟踪父集合。

track(): Word.WebSettings;

返回

Word.WebSettings

untrack()

释放与此对象关联的内存（如果先前已跟踪过）。此调用是 context.trackedObjects.remove (thisObject) 的简写。拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。需要在内存释放生效之前调用 context.sync() 。

untrack(): Word.WebSettings;

返回

Word.WebSettings

useDefaultFolderSuffix()

根据选定或安装的语言，将含指定文档的文件夹后缀设置为默认后缀。

useDefaultFolderSuffix(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

注解

使用方

属性

方法

属性详细信息

allowPng

属性值

注解

context

属性值

encoding

属性值

注解

folderSuffix

属性值

注解

organizeInFolder

属性值

注解

pixelsPerInch

属性值

注解

relyOnCSS

属性值

注解

relyOnVectorMarkupLanguage

属性值

注解

screenSize

属性值

注解

targetBrowser

属性值

注解

useLongFileNames

属性值

注解

方法详细信息

load(options)

参数

返回

load(propertyNames)

参数

返回

load(propertyNamesAndPaths)

参数

返回

toJSON()

返回

track()

返回

untrack()

返回

useDefaultFolderSuffix()

返回

注解

反馈