Word.Template class

代表一个文档模板。

注解

使用方

Word.文档： attachedTemplate
Word.TemplateCollection： getItemAt， items

属性

buildingBlockEntries	返回 `BuildingBlockEntryCollection` 表示模板中构建基块条目集合的对象。
buildingBlockTypes	返回表示 `BuildingBlockTypeItemCollection` 模板中包含的构建基块类型集合的对象。
context	与对象关联的请求上下文。这将加载项的进程连接到 Office 主机应用程序的进程。
farEastLineBreakLanguage	指定在文档或模板中断行文本时要使用的东亚语言。
farEastLineBreakLevel	指定文档的换行控制级别。
fullName	返回模板的名称，包括驱动器或 Web 路径。
hasNoProofing	指定拼写和语法检查是否忽略基于此模板的文档。
justificationMode	指定模板的字符间距调整。
kerningByAlgorithm	指定 Microsoft Word 是否对文档中的半角拉丁字符和标点符号进行字格调整。
languageId	指定一个 `LanguageId` 表示模板中语言的值。
languageIdFarEast	为模板中的语言指定东亚语言。
listTemplates	返回 `ListTemplateCollection` 表示模板中所有列表模板的对象。
name	仅返回文档模板的名称， (排除) 的任何路径或其他位置信息。
noLineBreakAfter	指定 Microsoft Word 不会换行的 kinsoku 字符。
noLineBreakBefore	指定 Microsoft Word 不会在该字符前面换行的 kinsoku 字符。
path	返回文档模板的路径。
saved	指定`true`模板自上次保存以来是否未更改，`false`以及 Microsoft Word 是否在关闭文档时显示保存更改的提示。
type	返回模板的类型。

方法

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

buildingBlockEntries

返回 BuildingBlockEntryCollection 表示模板中构建基块条目集合的对象。

readonly buildingBlockEntries: Word.BuildingBlockEntryCollection;

属性值

Word.BuildingBlockEntryCollection

注解

API 集：WordApiDesktop 1.3

buildingBlockTypes

返回表示 BuildingBlockTypeItemCollection 模板中包含的构建基块类型集合的对象。

readonly buildingBlockTypes: Word.BuildingBlockTypeItemCollection;

属性值

Word.BuildingBlockTypeItemCollection

注解

API 集：WordApiDesktop 1.3

context

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

context: RequestContext;

属性值

Word.RequestContext

farEastLineBreakLanguage

指定在文档或模板中断行文本时要使用的东亚语言。

farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese";

属性值

Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"

注解

API 集：WordApiDesktop 1.3

farEastLineBreakLevel

指定文档的换行控制级别。

farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom";

属性值

Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"

注解

API 集：WordApiDesktop 1.3

fullName

返回模板的名称，包括驱动器或 Web 路径。

readonly fullName: string;

属性值

string

注解

API 集：WordApiDesktop 1.3

hasNoProofing

指定拼写和语法检查是否忽略基于此模板的文档。

hasNoProofing: boolean;

属性值

boolean

注解

API 集：WordApiDesktop 1.3

justificationMode

指定模板的字符间距调整。

justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana";

属性值

Word.JustificationMode | "Expand" | "Compress" | "CompressKana"

注解

API 集：WordApiDesktop 1.3

kerningByAlgorithm

指定 Microsoft Word 是否对文档中的半角拉丁字符和标点符号进行字格调整。

kerningByAlgorithm: boolean;

属性值

boolean

注解

API 集：WordApiDesktop 1.3

languageId

指定一个 LanguageId 表示模板中语言的值。

languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu";

属性值

注解

API 集：WordApiDesktop 1.3

languageIdFarEast

为模板中的语言指定东亚语言。

languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu";

属性值

注解

API 集：WordApiDesktop 1.3

listTemplates

返回 ListTemplateCollection 表示模板中所有列表模板的对象。

readonly listTemplates: Word.ListTemplateCollection;

属性值

Word.ListTemplateCollection

注解

API 集：WordApiDesktop 1.4

name

仅返回文档模板的名称， (排除) 的任何路径或其他位置信息。

readonly name: string;

属性值

string

注解

API 集：WordApiDesktop 1.3

noLineBreakAfter

指定 Microsoft Word 不会换行的 kinsoku 字符。

noLineBreakAfter: string;

属性值

string

注解

API 集：WordApiDesktop 1.3

noLineBreakBefore

指定 Microsoft Word 不会在该字符前面换行的 kinsoku 字符。

noLineBreakBefore: string;

属性值

string

注解

API 集：WordApiDesktop 1.3

path

返回文档模板的路径。

readonly path: string;

属性值

string

注解

API 集：WordApiDesktop 1.3

saved

指定true模板自上次保存以来是否未更改，false以及 Microsoft Word 是否在关闭文档时显示保存更改的提示。

saved: boolean;

属性值

boolean

注解

API 集：WordApiDesktop 1.3

type

返回模板的类型。

readonly type: Word.TemplateType | "Normal" | "Global" | "Attached";

属性值

Word.TemplateType | "Normal" | "Global" | "Attached"

注解

API 集：WordApiDesktop 1.3

load(options)

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

load(options?: Word.Interfaces.TemplateLoadOptions): Word.Template;

参数

options: Word.Interfaces.TemplateLoadOptions

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

返回

Word.Template

load(propertyNames)

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

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

参数

propertyNames: string | string[]

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

返回

Word.Template

load(propertyNamesAndPaths)

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

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

参数

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

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

返回

Word.Template

save()

保存模板。

save(): void;

返回

void

注解

API 集：WordApiDesktop 1.3

set(properties, options)

同时设置对象的多个属性。可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。

set(properties: Interfaces.TemplateUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

properties: Word.Interfaces.TemplateUpdateData

一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。

options: OfficeExtension.UpdateOptions

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。

返回

void

set(properties)

基于现有加载的对象，同时在对象上设置多个属性。

set(properties: Word.Template): void;

参数

properties: Word.Template

返回

void

toJSON()

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

toJSON(): Word.Interfaces.TemplateData;

返回

Word.Interfaces.TemplateData

track()

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

track(): Word.Template;

返回

Word.Template

untrack()

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

untrack(): Word.Template;

返回

Word.Template

注解

使用方

属性

方法

属性详细信息

buildingBlockEntries

属性值

注解

buildingBlockTypes

属性值

注解

context

属性值

farEastLineBreakLanguage

属性值

注解

farEastLineBreakLevel

属性值

注解

fullName

属性值

注解

hasNoProofing

属性值

注解

justificationMode

属性值

注解

kerningByAlgorithm

属性值

注解

languageId

属性值

注解

languageIdFarEast

属性值

注解

listTemplates

属性值

注解

name

属性值

注解

noLineBreakAfter

属性值

注解

noLineBreakBefore

属性值

注解

path

属性值

注解

saved

属性值

注解

type

属性值

注解

方法详细信息

load(options)

参数

返回

load(propertyNames)

参数

返回

load(propertyNamesAndPaths)

参数

返回

save()

返回

注解

set(properties, options)

参数

返回

set(properties)

参数

返回

toJSON()

返回