ListField 类

有效显示项目列表的形状字段能力。

继承层次结构

System.Object
  Microsoft.VisualStudio.Modeling.Diagrams.ShapeField
    Microsoft.VisualStudio.Modeling.Diagrams.ListField

命名空间：  Microsoft.VisualStudio.Modeling.Diagrams
程序集：  Microsoft.VisualStudio.Modeling.Sdk.Diagrams.12.0（在 Microsoft.VisualStudio.Modeling.Sdk.Diagrams.12.0.dll 中）

语法

声明
Public Class ListField _
    Inherits ShapeField

public class ListField : ShapeField

ListField 类型公开以下成员。

构造函数

	名称	说明
	ListField(String)	初始化 ListField 类的新实例。
	ListField(String, Boolean, String, String)	初始化 ListField 类的新实例。

页首

属性

	名称	说明
	AlternateFontId	获取或设置标准的、未选中列表项的字体 ID。
	AnchoringBehavior	描述该字段的内容应该如何放置和调整有关父 ShapeElement 大小。 （继承自 ShapeField。）
	DefaultAccessibleDescription	获取或设置默认可访问说明。 （继承自 ShapeField。）
	DefaultAccessibleName	获取或设置可访问对象的形状字段的默认名称。 （继承自 ShapeField。）
	DefaultAccessibleState	为可访问对象获取形状字段的默认状态。 （继承自 ShapeField。）
	DefaultBackgroundBrushId	获取或设置用于绘制形状字段的背景的默认画笔的 ID。 （继承自 ShapeField。）
	DefaultFocusable	获取形状字段并验证它是否可以接收焦点，或者对形状字段提供接收焦点的功能。 （继承自 ShapeField。）
	DefaultInactiveSelectedBackgroundBrushId	获取或设置形状字段的默认背景画笔的 ID。 （继承自 ShapeField。）
	DefaultItemFocusable	获取或设置所有列表项的默认可设置焦点的状态。
	DefaultItemIndent	获取标准边距使用在列表字段的左侧和列表项之间的左侧。
	DefaultItemSelectable	获取或设置所有列表项的默认可选择状态。
	DefaultPenId	获取或设置用于形状字段的默认钢笔的 ID。 （继承自 ShapeField。）
	DefaultReflectParentFocusedState	获取子形状字段，并确认在其父形状接收焦点或将功能设置为反射其父形状的焦点状态时，它是否应接收焦点。 （继承自 ShapeField。）
	DefaultReflectParentSelectedState	获取子形状字段，并确认在选中其父形状或将功能设置为反射其父形状的选中状态时，是否应选中它。 （继承自 ShapeField。）
	DefaultSelectable	获取形状字段并验证是否选择默认情况下或设置形状字段的默认选择状态。 （继承自 ShapeField。）
	DefaultSelectedBackgroundBrushId	获取或设置形状字段的默认背景画笔的 ID。 （继承自 ShapeField。）
	DefaultStringFormat	所有列表项的默认格式字符串
	DefaultVisibility	获取形状字段并验证是否默认情况下显示或设置形状字段的默认可见性。 （继承自 ShapeField。）
	DisabledTextBrushId	获取或设置已禁用列表项的文本的画笔 ID。
	FocusBackgroundPenId	获取或设置用于概括焦点集中的列表项的钢笔 ID。
	FocusPenId	获取或设置用于概括焦点集中的列表项的钢笔 ID。
	InactiveSelectedBackgroundBrushId	获取或设置不活动、已选中列表项的背景色的画笔 ID。
	InactiveSelectedDisabledTextBrushId	获取或设置不活动、已选中列表项的文本的画笔 ID。
	InactiveSelectedTextBrushId	获取或设置不活动、已选中列表项的文本的画笔 ID。
	JaggedSelectionRectangle	获取或设置 jaggedSelection 属性。如果该属性被设置为 TRUE， 则选中的矩形宽度将仅覆盖子字段内容，而非整个字段的宽度。该设置默认为 false。
	Name	获取形状字段的名称。 （继承自 ShapeField。）
	NormalBackgroundBrushId	获取或设置标准的、未选中列表项的背景色的画笔 ID。
	NormalFontId	获取或设置标准的、未选中列表项的字体 ID。
	NormalTextBrushId	获取或设置标准的、未选中列表项的文本的画笔 ID。
	SelectedBackgroundBrushId	获取或设置选中列表项的背景色的画笔 ID。
	SelectedDisabledTextBrushId	获取或设置已选中、禁用的列表项的文本的画笔 ID。
	SelectedTextBrushId	获取或设置已选中列表项的文本的画笔 ID。
	SnakedList	获取指示列表项是否划分为多个列的值。如果该属性被设置为 TRUE，且被列表占据的空间中，有太多符合项，则字段列表中的项将被调整到表格列。可见行和列的当前 # 以动态方式进行计算，以便列表将最大化可以当前大小显示的项数。
	WatermarkFormat	所有列表项的默认格式字符串

页首

方法

	名称	说明
	AccessibleDoDefaultAction	执行该辅助性对象的默认操作。 （继承自 ShapeField。）
	AllowInPlaceEditorAutoSize	使在位编辑器自动调整到形状字段的大小。 （继承自 ShapeField。）
	AssociateValueWith(Store, AssociatedPropertyInfo)	将形状字段与分配到形状元素的域属性关联。 （继承自 ShapeField。）
	AssociateValueWith(Store, Guid)	将形状字段与分配到形状元素的域属性关联。 （继承自 ShapeField。）
	AssociateValueWith(Store, Guid, AssociatedPropertyInfo)	将形状字段与分配到形状元素的域属性关联。 （继承自 ShapeField。）
	AssociateVisibilityWith(Store, AssociatedPropertyInfo)	将形状字段的可见性与分配到形状元素的域属性关联。 （继承自 ShapeField。）
	AssociateVisibilityWith(Store, Guid)	将形状字段的可见性与分配到形状元素的域属性关联。 （继承自 ShapeField。）
	AssociateVisibilityWith(Store, Guid, AssociatedPropertyInfo)	将形状字段的可见性与分配到形状元素的域属性关联。 （继承自 ShapeField。）
	CanEditValue	获取形状字段并验证它是否可以编辑。 （继承自 ShapeField。）
	CommitPendingEdit	提交挂起的编辑。 （继承自 ShapeField。）
	DoHitTest	检索命中测试信息，包括哪个列表项。 （重写 ShapeField.DoHitTest(PointD, ShapeElement, DiagramHitTestInfo)。）
	DoKeyboardNavigation	在形状段用此键盘导航。 （继承自 ShapeField。）
	DoPaint	绘制形状字段。 （重写 ShapeField.DoPaint(DiagramPaintEventArgs, ShapeElement)。）
	EditValue(ShapeElement, DiagramClientView)	打开形状字段的内置编辑器。 （继承自 ShapeField。）
	EditValue(ShapeElement, DiagramClientView, PointD)	打开形状字段的内置编辑器。 （继承自 ShapeField。）
	Equals	确定指定的对象是否等于当前对象。 （继承自 Object。）
	Finalize	允许对象在“垃圾回收”回收之前尝试释放资源并执行其他清理操作。 （继承自 Object。）
	FindFirstChild	找到在父形状字段中的第一个子形状字段。 （继承自 ShapeField。）
	FindLastChild	找到在父形状字段中的最后一个子形状字段。 （继承自 ShapeField。）
	FindNextChild	找到在父形状字段中的下一个子形状字段。 （继承自 ShapeField。）
	FindNextInChildSubFields	在导航序列中查找此 ShapeField 的下一个子类子域。 （重写 ShapeField.FindNextInChildSubFields(ShapeElement, DiagramItem, Boolean)。）
	FindPreviousChild	找到在父形状字段中的上一个子形状字段。 （继承自 ShapeField。）
	FindPreviousInChildSubFields	在导航序列中查找此 ShapeField 的前一个子类子域。 （重写 ShapeField.FindPreviousInChildSubFields(ShapeElement, DiagramItem, Boolean)。）
	Focused	获取形状字段并验证是否具有焦点。 （继承自 ShapeField。）
	GetAccessibilityObject	获取分配给形状字段的 accessibility 对象。 （继承自 ShapeField。）
	GetAccessibleChild	检索对应于指定索引的辅助性子子字段。 （重写 ShapeField.GetAccessibleChild(ShapeElement, Int32)。）
	GetAccessibleChildCount	检索属于此 ShapeField 的可访问子级的个数。 （重写 ShapeField.GetAccessibleChildCount(ShapeElement)。）
	GetAccessibleDefaultActionDescription	为可访问对象获取形状字段的默认用途。 （继承自 ShapeField。）
	GetAccessibleDescription	返回列表字段的默认辅助性说明。 （重写 ShapeField.GetAccessibleDescription(ShapeElement)。）
	GetAccessibleHelp	获取辅助性对象的形状字段 Help。 （继承自 ShapeField。）
	GetAccessibleHelpTopicFileName	为可访问的对象在“帮助”中获取主题。 （继承自 ShapeField。）
	GetAccessibleHelpTopicId	获取可访问对象的帮助主题 ID。 （继承自 ShapeField。）
	GetAccessibleName	返回列表字段的默认辅助性名称。 （重写 ShapeField.GetAccessibleName(ShapeElement)。）
	GetAccessibleRole	检索此 ShapeField 的辅助性角色。 （重写 ShapeField.GetAccessibleRole(ShapeElement)。）
	GetAccessibleState	获取用于可访问对象的形状字段的状态。 （继承自 ShapeField。）
	GetAccessibleValue	获取可访问对象的形状字段中的值。 （继承自 ShapeField。）
	GetActiveInPlaceEditor	获取活动的就地编辑。 （继承自 ShapeField。）
	GetBackgroundBrush	获取将绘制此形状字段将分配到的形状元素的背景的画笔。 （继承自 ShapeField。）
	GetBackgroundBrushId	获取一个画笔 ID，该画笔被用来绘制当前形状被分配到的形状的背景。 （继承自 ShapeField。）
	GetBounds	获取使用世界单位、与父形状的最左端相对的 ShapeField 的边界。 （重写 ShapeField.GetBounds(ShapeElement)。）
	GetCursor	获取当鼠标指向形状字段时显示的指针。 （继承自 ShapeField。）
	GetFocusable	获取形状字段并验证它是否可以接收该焦点。 （继承自 ShapeField。）
	GetHashCode	作为默认哈希函数。 （继承自 Object。）
	GetInPlaceEditorBounds	获取就绪编辑器的边界。 （继承自 ShapeField。）
	GetItemCount	获取此列表字段中的项数。
	GetItemFocusable	获取一个值，该值指示指定的列表项是否可设置焦点。
	GetItemHeight	获取一个列表项的标准高度，单位为世界单位。此方法的默认行为返回 GetItemTextHeight、GetPaddingAboveItemText 和 GetPaddingBelowItemText 的总和。
	GetItemRectangle	获取列表项相对于父形状左上角的矩形，单位为世界单位。
	GetItemSelectable	获取一个值，该值指示指定的列表项是否可选定。
	GetItemTextHeight	在列表项中获取一行文本的高度。此文本高度 (Font.GetHeight ()) 包含一些填充，因此，GetPaddingAboveItemText 和 GetPaddingBelowItemText 是其顶部的额外填充。
	GetMaximumInPlaceEditorSize	获取就地编辑的最大边界。 （继承自 ShapeField。）
	GetMinimumInPlaceEditorSize	获取就地编辑的最大边界。 （继承自 ShapeField。）
	GetMinimumSize	获取用于形状字段的最小宽度和高度。 （继承自 ShapeField。）
	GetPaddingAboveItemText	返回项的顶部和文本的顶部之间所需的空间。文本高度 (Font.GetHeight()) 包含一些填充，除此之外的填塞。
	GetPaddingBelowItemText	返回 中的文本的底部和项的底部之间所需的空间。文本高度 (Font.GetHeight()) 包含一些填充，除此之外的填塞。
	GetPen	获取用于绘制形状字段被分配到的形状元素的钢笔。 （继承自 ShapeField。）
	GetPenId	获取形状字段被指定到的形状要素的笔 ID 。 （继承自 ShapeField。）
	GetPotentialMouseAction	在用户接下来单击关系图上特定点时，获取引起该事件的鼠标操作并将其激活。 （继承自 ShapeField。）
	GetSelectable	获取形状字段并验证它是否可以选择。 （继承自 ShapeField。）
	GetType	获取当前实例的 Type。 （继承自 Object。）
	GetValue	获取形状字段中的值。 （继承自 ShapeField。）
	GetValueDomainPropertyInfo	获取向形状字段中的值赋予的域属性。 （继承自 ShapeField。）
	GetVisible	获取形状字段并验证是否显示。 （继承自 ShapeField。）
	HasFocusedAppearance	获取形状字段并验证它是否应显示一个具有焦点。 （继承自 ShapeField。）
	HasPendingEdit	获取形状字段并验证就地编辑是否处于活动状态并更改挂起。 （继承自 ShapeField。）
	HasSelectedAppearance	获取形状字段并验证是否显示选中。 （继承自 ShapeField。）
	IsNavigationKey(Char)	获取用户按下的键并验证它是否可用于形状之间字段的导航。 （继承自 ShapeField。）
	IsNavigationKey(Keys)	获取用户按下的按键组合并验证它们是否可用于形状之间字段的导航。 （继承自 ShapeField。）
	MemberwiseClone	创建当前 Object 的浅表副本。 （继承自 Object。）
	NavigateAscend	移动焦点至用于选定形状的导航序列的上一个形状字段。 （继承自 ShapeField。）
	NavigateDescend	移动焦点至用于选定形状的导航序列的下一个形状字段。 （继承自 ShapeField。）
	NavigateToFirst	移动焦点至用于选定形状的导航序列的第一个形状字段。 （继承自 ShapeField。）
	NavigateToLast	移动 焦点至用于选定形状的导航序列的最后的形状字段。 （继承自 ShapeField。）
	NavigateToNext	移动焦点至用于选定形状的导航序列的下一个形状字段。 （继承自 ShapeField。）
	NavigateToPrevious	移动焦点至用于选定形状的导航序列的上一个形状字段。 （继承自 ShapeField。）
	OnBeginEdit	当就地编辑启动时，警报侦听器。 （继承自 ShapeField。）
	OnClick	当用户单击形状字段时，警报侦听器。 （继承自 ShapeField。）
	OnDoubleClick	当用户双击形状字段时，警报侦听器。 （继承自 ShapeField。）
	OnEndEdit	当就地编辑完成时，警报侦听器。 （继承自 ShapeField。）
	OnKeyDown	当指向形状字段，用户按住了密钥时，警报侦听器。 （继承自 ShapeField。）
	OnKeyPress	当指向形状字段，用户按住密钥时，警报侦听器。 （继承自 ShapeField。）
	OnKeyUp	当指向形状字段，用户释放了密钥时，警报侦听器。 （继承自 ShapeField。）
	OnMouseDown	用户按住鼠标按钮到形状字段上时，警报侦听器。 （继承自 ShapeField。）
	OnMouseMove	鼠标移动到形状字段上时，警报侦听器。 （继承自 ShapeField。）
	OnMouseUp	用户释放鼠标按钮到形状字段上时，警报侦听器。 （继承自 ShapeField。）
	OnMouseWheel	鼠标旋转到形状字段上时，警报侦听器。 （继承自 ShapeField。）
	Selected	获取形状字段并验证它是否已选中。 （继承自 ShapeField。）
	SetSelectionRange	设置该选择到子字段的范围。 （重写 ShapeField.SetSelectionRange(SelectedShapesCollection, DiagramItem, DiagramItem)。）
	SetValue	将指定的参数赋予形状字段。 （继承自 ShapeField。）
	SetVisible	设置形状字段的可见性。 （继承自 ShapeField。）
	ToString	返回表示当前对象的字符串。 （继承自 Object。）

页首

备注

若要添加 ListField 到 ShapeElement，请重写 ShapeElement 的 InitializeShapeFields 方法。 ShapeElement 还必须实现 IListFieldContainer 接口。

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。但不保证所有实例成员都是线程安全的。

请参阅

参考

Microsoft.VisualStudio.Modeling.Diagrams 命名空间