Partager via

ListField Class

  • Article

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.10.0 (in Microsoft.VisualStudio.Modeling.Sdk.Diagrams.10.0.dll)

Syntax

'Déclaration
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
Public method ListField(String) Initializes a new instance of the ListField class.
Public method ListField(String, Boolean, String, String) Initializes a new instance of the ListField class.

Top

Properties

  Name Description
Public property AlternateFontId Gets or sets the font id for a normal, unselected list item.
Public property AnchoringBehavior Describes how the content of the field should position and size itself in relation to the parent ShapeElement. (Inherited from ShapeField.)
Public property DefaultAccessibleDescription Gets or sets the default accessible description. (Inherited from ShapeField.)
Public property DefaultAccessibleName Gets or sets the default name of the shape field for the accessible object. (Inherited from ShapeField.)
Public property DefaultAccessibleState Gets the default state of the shape field for the accessible object. (Inherited from ShapeField.)
Public property DefaultBackgroundBrushId Gets or sets the ID of the default brush to paint the background of the shape field. (Inherited from ShapeField.)
Public property 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.)
Public property DefaultInactiveSelectedBackgroundBrushId Gets or sets the ID of the default background brush for the shape field. (Inherited from ShapeField.)
Public property DefaultItemFocusable Gets or sets default focusable state of all list items.
Public property DefaultItemIndent Gets the standard margin to use between the left side of the list field and the left side of the list item.
Public property DefaultItemSelectable Gets or sets default selectable state of all list items.
Public property DefaultPenId Gets or sets the ID of the default pen to use for the shape field. (Inherited from ShapeField.)
Public property 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.)
Public property 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.)
Public property 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.)
Public property DefaultSelectedBackgroundBrushId Gets or sets the ID of the default background brush for the shape field. (Inherited from ShapeField.)
Public property DefaultStringFormat The default string format for all list items
Public property DefaultVisibility Gets the shape field and verifies whether it appears by default or sets the default visibility of the shape field. (Inherited from ShapeField.)
Public property DisabledTextBrushId Gets or sets the brush id for the text of a disabled list item.
Public property FocusBackgroundPenId Gets or sets the pen id used to outline the focused list item.
Public property FocusPenId Gets or sets the pen id used to outline the focused list item.
Public property InactiveSelectedBackgroundBrushId Gets or sets the brush id for the background of an inactive selected list item.
Public property InactiveSelectedDisabledTextBrushId Gets or sets the brush id for the text of an inactive selected disabled list item.
Public property InactiveSelectedTextBrushId Gets or sets the brush id for the text of an inactive selected list item.
Public property 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.
Public property Name Gets the name of the shape field. (Inherited from ShapeField.)
Public property NormalBackgroundBrushId Gets or sets the brush id for the background of a normal, unselected list item.
Public property NormalFontId Gets or sets the font id for a normal, unselected list item.
Public property NormalTextBrushId Gets or sets the brush id for the text of a normal, unselected list item.
Public property SelectedBackgroundBrushId Gets or sets the brush id for the background of a selected list item.
Public property SelectedDisabledTextBrushId Gets or sets the brush id for the text of a selected disabled list item.
Public property SelectedTextBrushId Gets or sets the brush id for the text of a selected list item.
Public property 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.
Public property WatermarkFormat The default string format for all list items

Top

Methods

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

See Also

Reference

Microsoft.VisualStudio.Modeling.Diagrams Namespace