/
word.interfaces.fieldupdatedata.yml
78 lines (77 loc) · 2.77 KB
/
word.interfaces.fieldupdatedata.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
### YamlMime:TSType
name: Word.Interfaces.FieldUpdateData
uid: 'word!Word.Interfaces.FieldUpdateData:interface'
package: word!
fullName: Word.Interfaces.FieldUpdateData
summary: 'An interface for updating data on the Field object, for use in `field.set({ ... })`<!-- -->.'
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: code
uid: 'word!Word.Interfaces.FieldUpdateData#code:member'
package: word!
fullName: code
summary: Specifies the field's code instruction.
remarks: |-
\[ [API set: WordApi 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
Note: The ability to set the code was introduced in WordApi 1.5.
isPreview: false
isDeprecated: false
syntax:
content: 'code?: string;'
return:
type: string
- name: data
uid: 'word!Word.Interfaces.FieldUpdateData#data:member'
package: word!
fullName: data
summary: >-
Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is null and it will throw a general
exception when code attempts to set it.
remarks: '\[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'data?: string;'
return:
type: string
- name: locked
uid: 'word!Word.Interfaces.FieldUpdateData#locked:member'
package: word!
fullName: locked
summary: 'Specifies whether the field is locked. `true` if the field is locked, `false` otherwise.'
remarks: '\[ [API set: WordApi 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'locked?: boolean;'
return:
type: boolean
- name: result
uid: 'word!Word.Interfaces.FieldUpdateData#result:member'
package: word!
fullName: result
summary: Gets the field's result data.
remarks: '\[ [API set: WordApi 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'result?: Word.Interfaces.RangeUpdateData;'
return:
type: '<xref uid="word!Word.Interfaces.RangeUpdateData:interface" />'
- name: showCodes
uid: 'word!Word.Interfaces.FieldUpdateData#showCodes:member'
package: word!
fullName: showCodes
summary: >-
Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed,
`false` otherwise.
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: true
isDeprecated: false
syntax:
content: 'showCodes?: boolean;'
return:
type: boolean