Share via


ListItemSubField Class

The sub field which represents an item in a ListField.

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.Modeling.Diagrams.ShapeSubField
    Microsoft.VisualStudio.Modeling.Diagrams.ListItemSubField

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

Syntax

'Declaration
Public Class ListItemSubField _
    Inherits ShapeSubField
public class ListItemSubField : ShapeSubField
public ref class ListItemSubField : public ShapeSubField
type ListItemSubField =  
    class 
        inherit ShapeSubField 
    end
public class ListItemSubField extends ShapeSubField

The ListItemSubField type exposes the following members.

Constructors

  Name Description
Public method ListItemSubField(Int32) Initializes a new instance of the ListItemSubField class.
Public method ListItemSubField(Int32, Int32, Int32) Initializes a new instance of the ListItemSubField class.

Top

Properties

  Name Description
Public property Column Gets or sets the zero-based column number of this list item.
Public property Row Gets or sets the zero-based row number of this list item.
Public property RowsPerColumn Gets/sets the number of rows per column of the list in which this item resides.
Public property SubFieldHashCode Serves as the hash function for the ListItemSubField. (Overrides ShapeSubField.SubFieldHashCode.)

Top

Methods

  Name Description
Public method AccessibleDoDefaultAction Performs the default action associated with this accessible object. (Inherited from ShapeSubField.)
Public method CanEditValue Returns a value indicating whether the value of this subfield can be edited. (Overrides ShapeSubField.CanEditValue(ShapeElement, ShapeField, DiagramClientView).)
Public method CommitPendingEdit Commits the pending edit. (Overrides ShapeSubField.CommitPendingEdit(ShapeElement, ShapeField, DiagramClientView).)
Public method DoKeyboardNavigation Calls the appropriate navigation method on the shape sub-field. (Inherited from ShapeSubField.)
Public method EditValue(ShapeElement, ShapeField, DiagramClientView) Invokes the in-place editor. (Overrides ShapeSubField.EditValue(ShapeElement, ShapeField, DiagramClientView).)
Public method EditValue(ShapeElement, ShapeField, DiagramClientView, PointD) Invokes the in-place editor, setting the caret using the specified mouse position. (Overrides ShapeSubField.EditValue(ShapeElement, ShapeField, DiagramClientView, PointD).)
Public method EditValue(ShapeElement, ShapeField, DiagramClientView, String) Invokes the in-place editor, replacing the text with the specified text.
Public method Equals (Inherited from ShapeSubField.)
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 GetAccessibilityObject Gets the AccessibleObject assigned to the subfield. (Inherited from ShapeSubField.)
Public method GetAccessibleDefaultActionDescription Gets a string that describes the default action of the object. Not all objects have a default action. (Inherited from ShapeSubField.)
Public method GetAccessibleDescription Returns the accessible description. (Inherited from ShapeSubField.)
Public method GetAccessibleHelp Gets a description of what the object does or how the object is used. (Inherited from ShapeSubField.)
Public method GetAccessibleHelpTopicFileName Gets the path to the Help file associated with this accessible object. (Inherited from ShapeSubField.)
Public method GetAccessibleHelpTopicId Gets an identifier for a Help topic identifier associated with this accessible object. (Inherited from ShapeSubField.)
Public method GetAccessibleName Returns the accessible name. (Inherited from ShapeSubField.)
Public method GetAccessibleRole Returns the accessible role. (Overrides ShapeSubField.GetAccessibleRole(ShapeElement, ShapeField).)
Public method GetAccessibleValue (Inherited from ShapeSubField.)
Public method GetActiveInPlaceEditor 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 subfield. (Overrides ShapeSubField.GetActiveInPlaceEditor(ShapeElement, ShapeField, DiagramClientView).)
Public method GetBounds Returns the bounds in world coordinates relative to the top-left of the parent shape. (Overrides ShapeSubField.GetBounds(ShapeElement, ShapeField).)
Public method GetCursor Gets the cursor that is displayed when the mouse pointer is over the ShapeSubField. (Inherited from ShapeSubField.)
Public method GetFocusable Gets a value indicating whether this shape field can receive focus. (Overrides ShapeSubField.GetFocusable(ShapeElement, ShapeField).)
Public method GetHashCode (Inherited from ShapeSubField.)
Public method GetInPlaceEditorBounds Returns the bounds of the in-place editor relative to its parent shape in world units. (Overrides ShapeSubField.GetInPlaceEditorBounds(ShapeElement, ShapeField).)
Public method GetPotentialMouseAction Retrieves a mouse action that should be made active on the next MouseDown event if the mouse is over the specified point. (Inherited from ShapeSubField.)
Public method GetSelectable Gets a value indicating whether this shape field can be selected. (Overrides ShapeSubField.GetSelectable(ShapeElement, ShapeField).)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method HasPendingEdit Returns a value indicating whether in-place editing is active, with a commit pending. (Overrides ShapeSubField.HasPendingEdit(ShapeElement, ShapeField, DiagramClientView).)
Public method IsNavigationKey(Char) Returns a value indicating whether the specified character corresponds to a navigational command. (Inherited from ShapeSubField.)
Public method IsNavigationKey(Keys) Returns a value indicating whether the specified key data corresponds to a navigational command. (Inherited from ShapeSubField.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method NavigateAscend Called by this ShapeSubField to set focus to its first ancestor in the navigation sequence. (Inherited from ShapeSubField.)
Public method NavigateTo Sets the focus to the specified DiagramItem. (Inherited from ShapeSubField.)
Public method NavigateToFirst Called by this ShapeSubField to set focus to this subfield's first sibling (i.e., the parent's first child) in the navigation sequence. (Inherited from ShapeSubField.)
Public method NavigateToLast Called by this ShapeSubField to set focus to this subfield's last sibling (i.e., the parent's last child) in the navigation sequence. (Inherited from ShapeSubField.)
Public method NavigateToNext Called by this ShapeSubField to set focus to the next object in the navigation sequence. (Inherited from ShapeSubField.)
Public method NavigateToPrevious Called by this ShapeSubField to set focus to the previous object in the navigation sequence. (Inherited from ShapeSubField.)
Protected method OnBeginEdit Called when in-place editing has begun. (Inherited from ShapeSubField.)
Public method OnClick Called by the control's OnClick(). (Inherited from ShapeSubField.)
Public method OnDoubleClick Called by the control's OnDoubleClick(). (Inherited from ShapeSubField.)
Protected method OnEndEdit Called when in-place editing has ended. (Overrides ShapeSubField.OnEndEdit(DiagramItemEventArgs).)
Public method OnKeyDown Called when a key is pressed. (Overrides ShapeSubField.OnKeyDown(DiagramKeyEventArgs).)
Public method OnKeyPress Invokes the editor if the field is editable and any alpha-numeric character is typed. (Overrides ShapeSubField.OnKeyPress(DiagramKeyPressEventArgs).)
Public method OnKeyUp Called when a key is released. To be called, this ShapeSubField must be the focused ShapeSubField in the selection. (Inherited from ShapeSubField.)
Public method OnMouseDown Called by the control's OnMouseDown(). (Inherited from ShapeSubField.)
Public method OnMouseMove Called by the control's OnMouseMove(). (Inherited from ShapeSubField.)
Public method OnMouseUp Called by the control's OnMouseUp(). (Inherited from ShapeSubField.)
Public method OnMouseWheel Called by the control's OnMouseWheel(). (Inherited from ShapeSubField.)
Public method SubFieldEquals Determines whether two subfield instances are equal. (Overrides ShapeSubField.SubFieldEquals(Object).)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

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