Word.DropDownListContentControl class
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.
The data specific to content controls of type DropDownList.
- Extends
Remarks
[ API set: WordApi BETA (PREVIEW ONLY) ]
Properties
context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
list |
Gets the collection of list items in the dropdown list content control. |
Methods
add |
Adds a new list item to this dropdown list content control and returns a Word.ContentControlListItem object. |
delete |
Deletes all list items in this dropdown list content control. |
load(property |
Queues up a command to load the specified properties of the object. You must call |
load(property |
Queues up a command to load the specified properties of the object. You must call |
toJSON() | Overrides the JavaScript |
track() | Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across |
untrack() | Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call |
Property Details
context
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.
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;
Property Value
listItems
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.
Gets the collection of list items in the dropdown list content control.
readonly listItems: Word.ContentControlListItemCollection;
Property Value
Remarks
Method Details
addListItem(displayText, value, index)
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.
Adds a new list item to this dropdown list content control and returns a Word.ContentControlListItem object.
addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem;
Parameters
- displayText
-
string
Required. Display text of the list item.
- value
-
string
Optional. Value of the list item.
- index
-
number
Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list.
Returns
Remarks
deleteAllListItems()
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.
Deletes all list items in this dropdown list content control.
deleteAllListItems(): void;
Returns
void
Remarks
load(propertyNames)
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.
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(propertyNames?: string | string[]): Word.DropDownListContentControl;
Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
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.
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.DropDownListContentControl;
Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand
is a comma-delimited string that specifies the navigation properties to load.
Returns
toJSON()
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.
Overrides the JavaScript toJSON()
method in order to provide more useful output when an API object is passed to JSON.stringify()
. (JSON.stringify
, in turn, calls the toJSON
method of the object that is passed to it.) Whereas the original Word.DropDownListContentControl object is an API object, the toJSON
method returns a plain JavaScript object (typed as Word.Interfaces.DropDownListContentControlData
) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Word.Interfaces.DropDownListContentControlData;
Returns
track()
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.
Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync
calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
track(): Word.DropDownListContentControl;
Returns
untrack()
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.
Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync()
before the memory release takes effect.
untrack(): Word.DropDownListContentControl;
Returns
Office Add-ins
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for