Word.Interfaces.TemplateLoadOptions interface
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.
Represents a document template.
Remarks
Properties
| $all | Specifying |
| far |
Specifies the East Asian language to use when breaking lines of text in the document or template. |
| far |
Specifies the line break control level for the document. |
| full |
Returns the name of the template, including the drive or Web path. |
| has |
Specifies whether the spelling and grammar checker ignores documents based on this template. |
| justification |
Specifies the character spacing adjustment for the template. |
| kerning |
Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. |
| language |
Specifies a |
| language |
Specifies an East Asian language for the language in the template. |
| name | Returns only the name of the document template (excluding any path or other location information). |
| no |
Specifies the kinsoku characters after which Microsoft Word will not break a line. |
| no |
Specifies the kinsoku characters before which Microsoft Word will not break a line. |
| path | Returns the path to the document template. |
| saved | Specifies |
| type | Returns the template type. |
Property Details
$all
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.
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
farEastLineBreakLanguage
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.
Specifies the East Asian language to use when breaking lines of text in the document or template.
farEastLineBreakLanguage?: boolean;Property Value
boolean
Remarks
farEastLineBreakLevel
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.
Specifies the line break control level for the document.
farEastLineBreakLevel?: boolean;Property Value
boolean
Remarks
fullName
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.
Returns the name of the template, including the drive or Web path.
fullName?: boolean;Property Value
boolean
Remarks
hasNoProofing
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.
Specifies whether the spelling and grammar checker ignores documents based on this template.
hasNoProofing?: boolean;Property Value
boolean
Remarks
justificationMode
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.
Specifies the character spacing adjustment for the template.
justificationMode?: boolean;Property Value
boolean
Remarks
kerningByAlgorithm
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.
Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document.
kerningByAlgorithm?: boolean;Property Value
boolean
Remarks
languageId
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.
Specifies a LanguageId value that represents the language in the template.
languageId?: boolean;Property Value
boolean
Remarks
languageIdFarEast
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.
Specifies an East Asian language for the language in the template.
languageIdFarEast?: boolean;Property Value
boolean
Remarks
name
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.
Returns only the name of the document template (excluding any path or other location information).
name?: boolean;Property Value
boolean
Remarks
noLineBreakAfter
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.
Specifies the kinsoku characters after which Microsoft Word will not break a line.
noLineBreakAfter?: boolean;Property Value
boolean
Remarks
noLineBreakBefore
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.
Specifies the kinsoku characters before which Microsoft Word will not break a line.
noLineBreakBefore?: boolean;Property Value
boolean
Remarks
path
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.
Returns the path to the document template.
path?: boolean;Property Value
boolean
Remarks
saved
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.
Specifies true if the template has not changed since it was last saved, false if Microsoft Word displays a prompt to save changes when the document is closed.
saved?: boolean;Property Value
boolean
Remarks
type
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.
Returns the template type.
type?: boolean;Property Value
boolean