ContentControlListEntry Interface

Reference

Definition

Namespace:: Microsoft.Office.Interop.Word

Assembly:: Microsoft.Office.Interop.Word.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A ContentControlListEntry object represents a list item in a drop-down list or combo box content control. A ContentControlListEntry object is a member of the ContentControlListEntries collection for a ContentControl object.

public interface class ContentControlListEntry

[System.Runtime.InteropServices.Guid("0C6FA8CA-E65F-4FC7-AB8F-20729EECBB14")]
public interface ContentControlListEntry

type ContentControlListEntry = interface

Public Interface ContentControlListEntry

Attributes: GuidAttribute

Remarks

Use the Add(String, String, Int32) method of the ContentControlListEntries collection to create a new ContentControlListEntry object. Use the Item[Int32] method, or DropdownListEntries(Index), where Index is the ordinal position of the content control list item, to access an individual list item within the ContentControlListEntries collection.

Note: List entries must have unique display names. Attempting to add a list item that already exists raises a run-time error.

Use the MoveUp() and MoveDown() methods to reposition items in a drop-down list. Use the Select() method to programmatically select a content control list item.

Use the Text property to set the display text for a content control list item, and use the Value property to set a programmatic value that you may use later for processing a form. For example, you may use a content control drop-down list for a list of products. The Text property may contain the name of the product, a display name that a user can easily recognize and understand. The Value property may contain the product number for the product that corresponds to a product number in a database. You can then use the the product number from the Value property to look up product information in a database. Also, the value of the Value property is what is sent to the custom XML data if the content control is mapped to XML data in the data store.

Use the Delete() method to remove an item from a content control drop-down list or combo box.

Properties

Application	Returns an _Application object that represents the Microsoft Word application.
Creator	Returns a 32-bit integer that indicates the application in which the add-in was created. Read-only.
Index	Returns or sets the ordinal position of a content control list item in the collection of list items. Read/write.
Parent	Returns the parent object of the specified ContentControlListEntry object.
Text	Returns or sets the display text of a list item for a drop-down list or combo box content control. Read/write.
Value	Returns or sets the programmatic value of an item in a drop-down list or combo box content control. Read/write.

Methods

Delete()	Deletes the specified item in a combo box or drop-down list content control.
MoveDown()	Moves an item in a drop-down list or combo box content control down one item, so that it is after the item that originally followed it.
MoveUp()	Moves an item in a drop-down list or combo box content control up one item, so that it is before the item that originally preceded it.
Select()	Selects the list entry in a drop-down list or combo box content control and sets the text of the content control to the value of the item.

Applies to

Share via