Edit

Share via


Word.Interfaces.TemplateLoadOptions interface

Represents a document template.

Remarks

[ API set: WordApiDesktop 1.3 ]

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).

farEastLineBreakLanguage

Specifies the East Asian language to use when breaking lines of text in the document or template.

farEastLineBreakLevel

Specifies the line break control level for the document.

fullName

Returns the name of the template, including the drive or Web path.

hasNoProofing

Specifies whether the spelling and grammar checker ignores documents based on this template.

justificationMode

Specifies the character spacing adjustment for the template.

kerningByAlgorithm

Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document.

languageId

Specifies a LanguageId value that represents the language in the template.

languageIdFarEast

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).

noLineBreakAfter

Specifies the kinsoku characters after which Microsoft Word will not break a line.

noLineBreakBefore

Specifies the kinsoku characters before which Microsoft Word will not break a line.

path

Returns the path to the document template.

saved

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.

type

Returns the template type.

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

farEastLineBreakLanguage

Specifies the East Asian language to use when breaking lines of text in the document or template.

farEastLineBreakLanguage?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

farEastLineBreakLevel

Specifies the line break control level for the document.

farEastLineBreakLevel?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

fullName

Returns the name of the template, including the drive or Web path.

fullName?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

hasNoProofing

Specifies whether the spelling and grammar checker ignores documents based on this template.

hasNoProofing?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

justificationMode

Specifies the character spacing adjustment for the template.

justificationMode?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

kerningByAlgorithm

Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document.

kerningByAlgorithm?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

languageId

Specifies a LanguageId value that represents the language in the template.

languageId?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

languageIdFarEast

Specifies an East Asian language for the language in the template.

languageIdFarEast?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

name

Returns only the name of the document template (excluding any path or other location information).

name?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

noLineBreakAfter

Specifies the kinsoku characters after which Microsoft Word will not break a line.

noLineBreakAfter?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

noLineBreakBefore

Specifies the kinsoku characters before which Microsoft Word will not break a line.

noLineBreakBefore?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

path

Returns the path to the document template.

path?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

saved

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

[ API set: WordApiDesktop 1.3 ]

type

Returns the template type.

type?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]