ListField Class
Definition
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 shape field capable of efficiently displaying a list of items.
public ref class ListField : Microsoft::VisualStudio::Modeling::Diagrams::ShapeFieldpublic class ListField : Microsoft.VisualStudio.Modeling.Diagrams.ShapeFieldtype ListField = class
inherit ShapeFieldPublic Class ListField
Inherits ShapeField- Inheritance
Remarks
To add a ListField to a ShapeElement, override the ShapeElement's InitializeShapeFields method. The ShapeElement must also implement the IListFieldContainer interface.
Constructors
| ListField(String, Boolean, String, String) |
Initializes a new instance of the ListField class. |
| ListField(String) |
Initializes a new instance of the ListField class. |
Properties
| AlternateFontId |
Gets or sets the font id for a normal, unselected list item. |
| AnchoringBehavior |
Gets the AnchoringBehavior for this ShapeField. (Inherited from ShapeField) |
| DefaultAccessibleDescription |
Gets or sets the default accessible description. (Inherited from ShapeField) |
| DefaultAccessibleName |
Gets or sets the default accessible name. (Inherited from ShapeField) |
| DefaultAccessibleState |
Gets or sets the default accessible state. (Inherited from ShapeField) |
| DefaultBackgroundBrushId |
Gets or sets the id of the default background brush to use for this ShapeField. (Inherited from ShapeField) |
| DefaultFocusable |
Gets or sets a value indicating whether the ShapeField can receive focus by default. (Inherited from ShapeField) |
| DefaultInactiveSelectedBackgroundBrushId |
Gets or sets the id of the default background brush to use for this ShapeField. (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 this ShapeField. (Inherited from ShapeField) |
| DefaultReflectParentFocusedState |
Gets or sets a value indicating whether this field should show the focused state of its parent. (Inherited from ShapeField) |
| DefaultReflectParentSelectedState |
Gets or sets a value indicating whether this field should show the selected state of its parent. (Inherited from ShapeField) |
| DefaultSelectable |
Gets or sets a value indicating whether the ShapeField can be selected by default. (Inherited from ShapeField) |
| DefaultSelectedBackgroundBrushId |
Gets or sets the id of the default background brush to use for this ShapeField. (Inherited from ShapeField) |
| DefaultStringFormat |
The default string format for all list items |
| DefaultVisibility |
Gets or sets a value indicating whether the ShapeField is visible by default. (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 unique identifier for this ShapeField. (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 |
Methods
| AccessibleDoDefaultAction(ShapeElement) |
Performs the default action associated with this accessible object. (Inherited from ShapeField) |
| AllowInPlaceEditorAutoSize(ShapeElement) |
Returns a Boolean value indicating whether in-place editor should be allowed to size automatically. Default is false. (Inherited from ShapeField) |
| AssociateValueWith(Store, AssociatedPropertyInfo) |
Associates this shape field's value with a domain property on the ShapeElement. Use this method when the domain property is a proxy for another property. (Inherited from ShapeField) |
| AssociateValueWith(Store, Guid, AssociatedPropertyInfo) |
Associates this shape field's value with a domain property on the ShapeElement, when the shape is mapped to an instance of the given domain class. Use this method when there are multiple domain classes that this shape field can be mapped to. (Inherited from ShapeField) |
| AssociateValueWith(Store, Guid) |
Associates this shape field's value with a domain property on the ShapeElement. Use this method when the domain property is a proxy for another property. (Inherited from ShapeField) |
| AssociateVisibilityWith(Store, AssociatedPropertyInfo) |
Associates this shape field's visibility with a domain property on the ShapeElement. (Inherited from ShapeField) |
| AssociateVisibilityWith(Store, Guid, AssociatedPropertyInfo) |
Associates this shape field's visibility with a domain property on the ShapeElement, when the shape is mapped to an instance of the given domain class. Use this method when there are multiple domain classes that this shape field can be mapped to. (Inherited from ShapeField) |
| AssociateVisibilityWith(Store, Guid) |
Associates this shape field's visibility with a domain property on the ShapeElement. (Inherited from ShapeField) |
| CanEditValue(ShapeElement, DiagramClientView) |
Returns a value indicating whether the value of this field can be edited. (Inherited from ShapeField) |
| CommitPendingEdit(ShapeElement, DiagramClientView) |
Commits the pending edit. (Inherited from ShapeField) |
| DoHitTest(PointD, ShapeElement, DiagramHitTestInfo) |
Retrieves hit test information, including which list item. |
| DoKeyboardNavigation(Keys, DiagramClientView, DiagramItem) |
Calls the appropriate navigation method on the shape field. (Inherited from ShapeField) |
| DoPaint(DiagramPaintEventArgs, ShapeElement) |
Draws the shape field. |
| EditValue(ShapeElement, DiagramClientView, PointD) |
Invokes the in-place editor, setting the caret using the specified mouse position. (Inherited from ShapeField) |
| EditValue(ShapeElement, DiagramClientView) |
Invokes the in-place editor. (Inherited from ShapeField) |
| FindFirstChild(ShapeElement, Boolean) |
Called by this ShapeField to get its first child subfield in the navigation sequence. (Inherited from ShapeField) |
| FindLastChild(ShapeElement, Boolean) |
Called by this ShapeField to get its last subfield in the navigation sequence. (Inherited from ShapeField) |
| FindNextChild(DiagramItem, Boolean) |
Called by the ShapeSubField to get the next sibling item following it in the navigation sequence. (Inherited from ShapeField) |
| FindNextInChildSubFields(ShapeElement, DiagramItem, Boolean) |
Finds this ShapeField's next child subfield in the navigation sequence. |
| FindPreviousChild(DiagramItem, Boolean) |
Called by the ShapeSubField to get the next sibling item preceding it in the navigation sequence. (Inherited from ShapeField) |
| FindPreviousInChildSubFields(ShapeElement, DiagramItem, Boolean) |
Finds this ShapeField's previous child subfield in the navigation sequence. |
| Focused(ShapeElement, DiagramClientView) |
Gets a value indicating whether the ShapeField has the focus. (Inherited from ShapeField) |
| GetAccessibilityObject(ShapeElement, DiagramClientView) |
Gets the AccessibleObject assigned to the field. (Inherited from ShapeField) |
| GetAccessibleChild(ShapeElement, Int32) |
Retrieves the accessible child subfield corresponding to the specified index. |
| GetAccessibleChildCount(ShapeElement) |
Retrieves the number of accessible children belonging to this ShapeField. |
| GetAccessibleDefaultActionDescription(ShapeElement) |
Gets a string that describes the default action of the object. Not all objects have a default action. (Inherited from ShapeField) |
| GetAccessibleDescription(ShapeElement) |
Returns the default accessible description for a list field. |
| GetAccessibleHelp(ShapeElement) |
Gets a description of what the object does or how the object is used. (Inherited from ShapeField) |
| GetAccessibleHelpTopicFileName(ShapeElement) |
Gets the path to the Help file associated with this accessible object. (Inherited from ShapeField) |
| GetAccessibleHelpTopicId(ShapeElement) |
Gets an identifier for a Help topic identifier associated with this accessible object. (Inherited from ShapeField) |
| GetAccessibleName(ShapeElement) |
Returns the default accessible name for a list field. |
| GetAccessibleRole(ShapeElement) |
Retrieves the accessible role of this ShapeField. |
| GetAccessibleState(ShapeElement, DiagramClientView) |
Retrieves the accessible state of this ShapeField. (Inherited from ShapeField) |
| GetAccessibleValue(ShapeElement) |
Returns the accessible value. (Inherited from ShapeField) |
| GetActiveInPlaceEditor(ShapeElement, DiagramClientView) |
Returns the control for the active in-place editor. This method may return null, in which case no in-place editor is active for this field. (Inherited from ShapeField) |
| GetBackgroundBrush(DiagramClientView, ShapeElement, Color) |
Gets the background brush to draw with for the specified ShapeElement instance. (Inherited from ShapeField) |
| GetBackgroundBrushId(DiagramClientView, ShapeElement) |
Gets the id of the background brush to draw with for the specified ShapeElement instance. (Inherited from ShapeField) |
| GetBounds(ShapeElement) |
Gets the bounds of this ShapeField in world units relative to the top-left of the parent shape. |
| GetCursor(Cursor, DiagramClientView, PointD) |
Gets the cursor that is displayed when the mouse pointer is over the ShapeField. (Inherited from ShapeField) |
| GetFocusable(ShapeElement) |
Gets a value indicating whether the ShapeField can receive focus. (Inherited from ShapeField) |
| GetInPlaceEditorBounds(ShapeElement) |
Returns the bounds of the in-place editor relative to its parent shape in world units. (Inherited from ShapeField) |
| GetItemCount(ShapeElement) |
Gets the number of items in this list field. |
| GetItemFocusable(ShapeElement, ListItemSubField) |
Gets a value indicating whether the specified list item is focusable. |
| GetItemHeight(ShapeElement) |
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(ShapeElement, Int32, Int32) |
Gets the list item rectangle in world units relative to the top-left of the parent shape. |
| GetItemSelectable(ShapeElement, ListItemSubField) |
Gets a value indicating whether the specified list item is selectable. |
| GetItemTextHeight(ShapeElement) |
Gets the height of a line of text in the list item. |
| GetMaximumInPlaceEditorSize(ShapeElement) |
Returns the maximum bounds allowed for the in-place editor for the given parent shape. (Inherited from ShapeField) |
| GetMinimumInPlaceEditorSize(ShapeElement) |
Returns the minimum bounds allowed for the in-place editor for the given parent shape. (Inherited from ShapeField) |
| GetMinimumSize(ShapeElement) |
Gets the minimum width and height for this ShapeField in world units (Inherited from ShapeField) |
| GetPaddingAboveItemText(ShapeElement) |
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(ShapeElement) |
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(DiagramClientView, ShapeElement, Color) |
Gets the pen to draw with for the specified ShapeElement instance. (Inherited from ShapeField) |
| GetPenId(ShapeElement) |
Gets the id of the pen to draw with for the specified ShapeElement instance. (Inherited from ShapeField) |
| GetPotentialMouseAction(MouseButtons, PointD, DiagramHitTestInfo) |
Retrieves a mouse action that should be made active on the next MouseDown event if the mouse is over the specified point. By default, this method will return the SelectAction. If the field's CanEditValue returns true and the field is already focused, then the InvokeEditorAction will be returned instead. (Inherited from ShapeField) |
| GetSelectable(ShapeElement) |
Gets a value indicating whether the ShapeField is selectable. (Inherited from ShapeField) |
| GetValue(ShapeElement) |
Gets the value of this ShapeField for the specified ShapeElement instance. (Inherited from ShapeField) |
| GetValueDomainPropertyInfo(ShapeElement) |
Gets the DomainPropertyInfo for the value of this field. (Inherited from ShapeField) |
| GetVisible(ShapeElement) |
Gets a value indicating whether the ShapeField is visible (Inherited from ShapeField) |
| HasFocusedAppearance(ShapeElement, DiagramClientView) |
Returns a value that indicates whether this field should show the field as focused. This can be different from the Focused property when this field reflects the Focused state of its parent. (See DefaultReflectParentFocusedState property.) (Inherited from ShapeField) |
| HasPendingEdit(ShapeElement, DiagramClientView) |
Returns a value indicating whether in-place editing is active, with a commit pending. (Inherited from ShapeField) |
| HasSelectedAppearance(ShapeElement, DiagramClientView) |
Returns a value that indicates whether this field should show the field as selected. This can be different from the Selected property when this field reflects the Selected state of its parent. (See DefaultReflectParentSelectedState property.) (Inherited from ShapeField) |
| IsNavigationKey(Char) |
Returns a value indicating whether the specified character corresponds to a navigational command. (Inherited from ShapeField) |
| IsNavigationKey(Keys) |
Returns a value indicating whether the specified key data corresponds to a navigational command. (Inherited from ShapeField) |
| NavigateAscend(ShapeElement, SelectedShapesCollection) |
Called by this ShapeField to set focus to its first focusable ancestor in the navigation sequence. (Inherited from ShapeField) |
| NavigateDescend(ShapeElement, SelectedShapesCollection) |
Called by this ShapeField to set focus to its first focusable descendant in the navigation sequence. (Inherited from ShapeField) |
| NavigateToFirst(ShapeElement, SelectedShapesCollection) |
Called by this ShapeField to set focus to this field's first sibling (i.e., the parent's first child) in the navigation sequence. (Inherited from ShapeField) |
| NavigateToLast(ShapeElement, SelectedShapesCollection) |
Called by this ShapeField to set focus to this field's last sibling (i.e., the parent's last child) in the navigation sequence. (Inherited from ShapeField) |
| NavigateToNext(ShapeElement, SelectedShapesCollection) |
Called by this ShapeField to set focus to the next object in the navigation sequence. (Inherited from ShapeField) |
| NavigateToPrevious(ShapeElement, SelectedShapesCollection) |
Called by this ShapeField to set focus to the previous object in the navigation sequence. (Inherited from ShapeField) |
| OnBeginEdit(DiagramItemEventArgs) |
Called when in-place editing has begun. (Inherited from ShapeField) |
| OnClick(DiagramPointEventArgs) |
Called by the control's OnClick(). (Inherited from ShapeField) |
| OnDoubleClick(DiagramPointEventArgs) |
Called by the control's OnDoubleClick(). (Inherited from ShapeField) |
| OnEndEdit(DiagramItemEventArgs) |
Called when in-place editing has ended. (Inherited from ShapeField) |
| OnKeyDown(DiagramKeyEventArgs) |
Called when a key is pressed. To be called, this ShapeField must be the focused ShapeField in the selection. (Inherited from ShapeField) |
| OnKeyPress(DiagramKeyPressEventArgs) |
Called between a key down and key up. To be called, this ShapeField must be the focused ShapeField in the selection. (Inherited from ShapeField) |
| OnKeyUp(DiagramKeyEventArgs) |
Called when a key is released. To be called, this ShapeField must be the focused ShapeField in the selection. (Inherited from ShapeField) |
| OnMouseDown(DiagramMouseEventArgs) |
Called by the control's OnMouseDown(). (Inherited from ShapeField) |
| OnMouseMove(DiagramMouseEventArgs) |
Called by the control's OnMouseMove(). (Inherited from ShapeField) |
| OnMouseUp(DiagramMouseEventArgs) |
Called by the control's OnMouseUp(). (Inherited from ShapeField) |
| OnMouseWheel(DiagramMouseEventArgs) |
Called by the control's OnMouseWheel(). (Inherited from ShapeField) |
| Selected(ShapeElement, DiagramClientView) |
Returns a value indicating whether the field is selected. (Inherited from ShapeField) |
| SetSelectionRange(SelectedShapesCollection, DiagramItem, DiagramItem) |
Sets the selection to a range of subfields |
| SetValue(ShapeElement, Object) |
Sets the value of this ShapeField for the specified ShapeElement instance. (Inherited from ShapeField) |
| SetVisible(ShapeElement, Object) |
Sets the visibility of this ShapeField for the specified ShapeElement instance. (Inherited from ShapeField) |