ListField Class

项目
11/24/2013

A shape field capable of efficiently displaying a list of items.

Inheritance Hierarchy

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

Namespace: Microsoft.VisualStudio.Modeling.Diagrams
Assembly: Microsoft.VisualStudio.Modeling.Sdk.Diagrams.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Diagrams.12.0.dll)

Syntax

'Declaration
Public Class ListField _
    Inherits ShapeField

public class ListField : ShapeField

public ref class ListField : public ShapeField

type ListField =  
    class 
        inherit ShapeField 
    end

public class ListField extends ShapeField

The ListField type exposes the following members.

Constructors

	Name	Description
	ListField(String)	Initializes a new instance of the ListField class.
	ListField(String, Boolean, String, String)	Initializes a new instance of the ListField class.

Top

Properties

	Name	Description
	AlternateFontId	Gets or sets the font id for a normal, unselected list item.
	AnchoringBehavior	Describes how the content of the field should position and size itself in relation to the parent ShapeElement. (Inherited from ShapeField.)
	DefaultAccessibleDescription	Gets or sets the default accessible description. (Inherited from ShapeField.)
	DefaultAccessibleName	Gets or sets the default name of the shape field for the accessible object. (Inherited from ShapeField.)
	DefaultAccessibleState	Gets the default state of the shape field for the accessible object. (Inherited from ShapeField.)
	DefaultBackgroundBrushId	Gets or sets the ID of the default brush to paint the background of the shape field. (Inherited from ShapeField.)
	DefaultFocusable	Gets the shape field and verifies whether it can receive focus, or gives the shape field the ability to receive focus. (Inherited from ShapeField.)
	DefaultInactiveSelectedBackgroundBrushId	Gets or sets the ID of the default background brush for the shape field. (Inherited from ShapeField.)
	DefaultItemFocusable	Gets or sets default focusable state of all list items.
	DefaultItemIndent	Gets the standard margin to use between the left side of the list field and the left side of the list item.
	DefaultItemSelectable	Gets or sets default selectable state of all list items.
	DefaultPenId	Gets or sets the ID of the default pen to use for the shape field. (Inherited from ShapeField.)
	DefaultReflectParentFocusedState	Gets the child shape field and verifies whether it should receive focus when its parent shape receives focus or sets the ability to reflect the focus state of its parent shape. (Inherited from ShapeField.)
	DefaultReflectParentSelectedState	Gets the child shape field and verifies whether it should be selected when its parent shape is selected or sets the ability to reflect the selection state of its parent shape. (Inherited from ShapeField.)
	DefaultSelectable	Gets the shape field and verifies whether it can be selected by default or sets the default selection state of the shape field. (Inherited from ShapeField.)
	DefaultSelectedBackgroundBrushId	Gets or sets the ID of the default background brush for the shape field. (Inherited from ShapeField.)
	DefaultStringFormat	The default string format for all list items
	DefaultVisibility	Gets the shape field and verifies whether it appears by default or sets the default visibility of the shape field. (Inherited from ShapeField.)
	DisabledTextBrushId	Gets or sets the brush id for the text of a disabled list item.
	FocusBackgroundPenId	Gets or sets the pen id used to outline the focused list item.
	FocusPenId	Gets or sets the pen id used to outline the focused list item.
	InactiveSelectedBackgroundBrushId	Gets or sets the brush id for the background of an inactive selected list item.
	InactiveSelectedDisabledTextBrushId	Gets or sets the brush id for the text of an inactive selected disabled list item.
	InactiveSelectedTextBrushId	Gets or sets the brush id for the text of an inactive selected list item.
	JaggedSelectionRectangle	Gets or sets the jaggedSelection property. If this property is set to true, the width of the selection rectangles only covers the contents of the subfields, not the entire width of the field. This property defaults to false.
	Name	Gets the name of the shape field. (Inherited from ShapeField.)
	NormalBackgroundBrushId	Gets or sets the brush id for the background of a normal, unselected list item.
	NormalFontId	Gets or sets the font id for a normal, unselected list item.
	NormalTextBrushId	Gets or sets the brush id for the text of a normal, unselected list item.
	SelectedBackgroundBrushId	Gets or sets the brush id for the background of a selected list item.
	SelectedDisabledTextBrushId	Gets or sets the brush id for the text of a selected disabled list item.
	SelectedTextBrushId	Gets or sets the brush id for the text of a selected list item.
	SnakedList	Gets a value indicating whether the list items wrap into multiple columns. If this property is set to true, then the items in the list field will be snaked to form columns if there are too many items to fit in the space currently occupied by the list. The current # of possible visible rows and columns is dynamically calculated so that the list will maximize the number of entries that can be shown in its current size.
	WatermarkFormat	The default string format for all list items

Top

Methods

	Name	Description
	AccessibleDoDefaultAction	Performs the default action for the accessible object. (Inherited from ShapeField.)
	AllowInPlaceEditorAutoSize	Enables the in-place editor to be automatically sized in the shape field. (Inherited from ShapeField.)
	AssociateValueWith(Store, AssociatedPropertyInfo)	Associates the shape field with a domain property that is assigned to a shape element. (Inherited from ShapeField.)
	AssociateValueWith(Store, Guid)	Associates the shape field with a domain property that is assigned to a shape element. (Inherited from ShapeField.)
	AssociateValueWith(Store, Guid, AssociatedPropertyInfo)	Associates the shape field with a domain property that is assigned to a shape element. (Inherited from ShapeField.)
	AssociateVisibilityWith(Store, AssociatedPropertyInfo)	Associates the visibility of the shape field with a domain property that is assigned to a shape element. (Inherited from ShapeField.)
	AssociateVisibilityWith(Store, Guid)	Associates the visibility of the shape field with a domain property that is assigned to a shape element. (Inherited from ShapeField.)
	AssociateVisibilityWith(Store, Guid, AssociatedPropertyInfo)	Associates the visibility of the shape field with a domain property that is assigned to a shape element. (Inherited from ShapeField.)
	CanEditValue	Gets the shape field and verifies whether it can be edited. (Inherited from ShapeField.)
	CommitPendingEdit	Commits the pending edit. (Inherited from ShapeField.)
	DoHitTest	Retrieves hit test information, including which list item. (Overrides ShapeField.DoHitTest(PointD, ShapeElement, DiagramHitTestInfo).)
	DoKeyboardNavigation	Navigates in the shape field by using the keyboard. (Inherited from ShapeField.)
	DoPaint	Draws the shape field. (Overrides ShapeField.DoPaint(DiagramPaintEventArgs, ShapeElement).)
	EditValue(ShapeElement, DiagramClientView)	Opens the in-place editor for the shape field. (Inherited from ShapeField.)
	EditValue(ShapeElement, DiagramClientView, PointD)	Opens the in-place editor for the shape field. (Inherited from ShapeField.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FindFirstChild	Locates the first child shape field in the parent shape field. (Inherited from ShapeField.)
	FindLastChild	Locates the last child shape field in the parent shape field. (Inherited from ShapeField.)
	FindNextChild	Locates the next child shape field in the parent shape field. (Inherited from ShapeField.)
	FindNextInChildSubFields	Finds this ShapeField's next child subfield in the navigation sequence. (Overrides ShapeField.FindNextInChildSubFields(ShapeElement, DiagramItem, Boolean).)
	FindPreviousChild	Locates the previous child shape field in the parent shape field. (Inherited from ShapeField.)
	FindPreviousInChildSubFields	Finds this ShapeField's previous child subfield in the navigation sequence. (Overrides ShapeField.FindPreviousInChildSubFields(ShapeElement, DiagramItem, Boolean).)
	Focused	Gets the shape field and verifies whether it has focus. (Inherited from ShapeField.)
	GetAccessibilityObject	Gets the accessibility object that is assigned to the shape field. (Inherited from ShapeField.)
	GetAccessibleChild	Retrieves the accessible child subfield corresponding to the specified index. (Overrides ShapeField.GetAccessibleChild(ShapeElement, Int32).)
	GetAccessibleChildCount	Retrieves the number of accessible children belonging to this ShapeField. (Overrides ShapeField.GetAccessibleChildCount(ShapeElement).)
	GetAccessibleDefaultActionDescription	Gets the default purpose of the shape field for the accessible object. (Inherited from ShapeField.)
	GetAccessibleDescription	Returns the default accessible description for a list field. (Overrides ShapeField.GetAccessibleDescription(ShapeElement).)
	GetAccessibleHelp	Gets the shape field Help for the accessible object. (Inherited from ShapeField.)
	GetAccessibleHelpTopicFileName	Gets a topic in the Help for the accessible object. (Inherited from ShapeField.)
	GetAccessibleHelpTopicId	Gets the ID that is assigned to the Help topic for the accessible object. (Inherited from ShapeField.)
	GetAccessibleName	Returns the default accessible name for a list field. (Overrides ShapeField.GetAccessibleName(ShapeElement).)
	GetAccessibleRole	Retrieves the accessible role of this ShapeField. (Overrides ShapeField.GetAccessibleRole(ShapeElement).)
	GetAccessibleState	Gets the state of the shape field for the accessible object. (Inherited from ShapeField.)
	GetAccessibleValue	Gets the value in the shape field for the accessible object. (Inherited from ShapeField.)
	GetActiveInPlaceEditor	Gets the in-place editor that is active. (Inherited from ShapeField.)
	GetBackgroundBrush	Gets the brush that draws the background for the shape element to which this shape field is assigned. (Inherited from ShapeField.)
	GetBackgroundBrushId	Gets the ID of the brush that draws the background for the shape element to which this shape field is assigned. (Inherited from ShapeField.)
	GetBounds	Gets the bounds of this ShapeField in world units relative to the top-left of the parent shape. (Overrides ShapeField.GetBounds(ShapeElement).)
	GetCursor	Gets the pointer that appears when the mouse is pointing to the shape field. (Inherited from ShapeField.)
	GetFocusable	Gets the shape field and verifies whether it can receive focus. (Inherited from ShapeField.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetInPlaceEditorBounds	Gets the bounds for the in-place editor. (Inherited from ShapeField.)
	GetItemCount	Gets the number of items in this list field.
	GetItemFocusable	Gets a value indicating whether the specified list item is focusable.
	GetItemHeight	Gets the standard height of a list item in world units. The default behavior of this method returns the sum of GetItemTextHeight, GetPaddingAboveItemText, and GetPaddingBelowItemText.
	GetItemRectangle	Gets the list item rectangle in world units relative to the top-left of the parent shape.
	GetItemSelectable	Gets a value indicating whether the specified list item is selectable.
	GetItemTextHeight	Gets the height of a line of text in the list item. This text height (Font.GetHeight()) contains some padding, so GetPaddingAboveItemText and GetPaddingBelowItemText is additional padding on top of that.
	GetMaximumInPlaceEditorSize	Gets the maximum bounds for the in-place editor. (Inherited from ShapeField.)
	GetMinimumInPlaceEditorSize	Gets the minimum bounds for the in-place editor. (Inherited from ShapeField.)
	GetMinimumSize	Gets the minimum width and height for the shape field. (Inherited from ShapeField.)
	GetPaddingAboveItemText	Returns the spacing between the top of the item and the top of the text. The text height (Font.GetHeight()) contains some padding, so this is padding in addition to that.
	GetPaddingBelowItemText	Returns the spacing between the bottom of the text and the bottom of the item. The text height (Font.GetHeight()) contains some padding, so this is padding in addition to that.
	GetPen	Gets the pen that draws the shape element to which the shape field is assigned. (Inherited from ShapeField.)
	GetPenId	Gets the ID of the pen that draws the shape element to which the shape field is assigned. (Inherited from ShapeField.)
	GetPotentialMouseAction	Gets the mouse action to activate when the user next clicks a specific point on the diagram. (Inherited from ShapeField.)
	GetSelectable	Gets the shape field and verifies whether it can be selected. (Inherited from ShapeField.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Gets the value in the shape field. (Inherited from ShapeField.)
	GetValueDomainPropertyInfo	Gets the domain property that is assigned to the value in the shape field. (Inherited from ShapeField.)
	GetVisible	Gets the shape field and verifies whether it appears. (Inherited from ShapeField.)
	HasFocusedAppearance	Gets the shape field and verifies whether it should appear to have the focus. (Inherited from ShapeField.)
	HasPendingEdit	Gets the shape field and verifies whether its in-place editor is active and a change is pending. (Inherited from ShapeField.)
	HasSelectedAppearance	Gets the shape field and verifies whether it appears to be selected. (Inherited from ShapeField.)
	IsNavigationKey(Char)	Gets the key that the user pressed and verifies whether it can be used to navigate between shape fields. (Inherited from ShapeField.)
	IsNavigationKey(Keys)	Gets the keys that the user pressed and verifies whether they can be used to navigate between shape fields. (Inherited from ShapeField.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NavigateAscend	Moves the focus to the previous shape field in the navigation sequence for the selected shapes. (Inherited from ShapeField.)
	NavigateDescend	Moves the focus to the next shape field in the navigation sequence for the selected shapes. (Inherited from ShapeField.)
	NavigateToFirst	Moves the focus to the first shape field in the navigation sequence for the selected shapes. (Inherited from ShapeField.)
	NavigateToLast	Moves the focus to the last shape field in the navigation sequence for the selected shapes. (Inherited from ShapeField.)
	NavigateToNext	Moves the focus to the next shape field in the navigation sequence for the selected shapes. (Inherited from ShapeField.)
	NavigateToPrevious	Moves the focus to the previous shape field in the navigation sequence for the selected shapes. (Inherited from ShapeField.)
	OnBeginEdit	Alerts listeners when in-place editing has begun. (Inherited from ShapeField.)
	OnClick	Alerts listeners when the user has clicked a shape field. (Inherited from ShapeField.)
	OnDoubleClick	Alerts listeners when the user has double-clicked a shape field. (Inherited from ShapeField.)
	OnEndEdit	Alerts listeners when in-place editing has completed. (Inherited from ShapeField.)
	OnKeyDown	Alerts listeners when the user has held down a key when pointing to a shape field. (Inherited from ShapeField.)
	OnKeyPress	Alerts listeners when the user has pressed a key when pointing to a shape field. (Inherited from ShapeField.)
	OnKeyUp	Alerts listeners when the user has released a key when pointing to a shape field. (Inherited from ShapeField.)
	OnMouseDown	Alerts listeners when the user is holding down the mouse over a shape field. (Inherited from ShapeField.)
	OnMouseMove	Alerts listeners when the mouse has been moved over a shape field. (Inherited from ShapeField.)
	OnMouseUp	Alerts listeners when the user has released the mouse button over a shape field. (Inherited from ShapeField.)
	OnMouseWheel	Alerts listeners when the mouse has been rotated over a shape field. (Inherited from ShapeField.)
	Selected	Gets the shape field and verifies whether it is selected. (Inherited from ShapeField.)
	SetSelectionRange	Sets the selection to a range of subfields (Overrides ShapeField.SetSelectionRange(SelectedShapesCollection, DiagramItem, DiagramItem).)
	SetValue	Assigns the specified value to a shape field. (Inherited from ShapeField.)
	SetVisible	Sets the visibility of the shape field. (Inherited from ShapeField.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

To add a ListField to a ShapeElement, override the ShapeElement's InitializeShapeFields method. The ShapeElement must also implement the IListFieldContainer interface.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

通过