Share via


ShapeSubField Class

A sub component of a ShapeField that is optionally selectable, focusable, hit-testable, in-place-editable, and IAccessible. Examples of a ShapeSubField are list items in a list field, grid cells and grid lines in a grid field, and radio buttons in a radio button group. ShapeSubFields are only created as needed. For example, a grid containing 10,000 cells only needs to create a subfield for a cell when the subfield is selected, focused, hit-tested, edited, or accessed via IAccessible.

Inheritance Hierarchy

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

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 MustInherit Class ShapeSubField
public abstract class ShapeSubField
public ref class ShapeSubField abstract
[<AbstractClass>]
type ShapeSubField =  class end
public abstract class ShapeSubField

The ShapeSubField type exposes the following members.

Constructors

  Name Description
Protected method ShapeSubField Initializes a new instance of the ShapeSubField class.

Top

Properties

  Name Description
Public property SubFieldHashCode Gets a hash code for this ShapeSubField.

Top

Methods

  Name Description
Public method AccessibleDoDefaultAction Performs the default action associated with this accessible object.
Public method CanEditValue Returns a value indicating whether the value of this subfield can be edited.
Public method CommitPendingEdit Commits the pending edit.
Public method DoKeyboardNavigation Calls the appropriate navigation method on the shape sub-field.
Public method EditValue(ShapeElement, ShapeField, DiagramClientView) Invokes the in-place editor.
Public method EditValue(ShapeElement, ShapeField, DiagramClientView, PointD) Invokes the in-place editor, setting the caret using the specified mouse position.
Public method Equals (Overrides Object.Equals(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 GetAccessibilityObject Gets the AccessibleObject assigned to the subfield.
Public method GetAccessibleDefaultActionDescription Gets a string that describes the default action of the object. Not all objects have a default action.
Public method GetAccessibleDescription Returns the accessible description.
Public method GetAccessibleHelp Gets a description of what the object does or how the object is used.
Public method GetAccessibleHelpTopicFileName Gets the path to the Help file associated with this accessible object.
Public method GetAccessibleHelpTopicId Gets an identifier for a Help topic identifier associated with this accessible object.
Public method GetAccessibleName Returns the accessible name.
Public method GetAccessibleRole Returns the accessible role.
Public method GetAccessibleValue
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.
Public method GetBounds Returns the bounds in world coordinates relative to the top-left of the parent shape.
Public method GetCursor Gets the cursor that is displayed when the mouse pointer is over the ShapeSubField.
Public method GetFocusable Gets a value indicating whether this ShapeSubField is focusable.
Public method GetHashCode (Overrides Object.GetHashCode().)
Public method GetInPlaceEditorBounds Returns the bounds of the in-place editor relative to its parent shape in world units.
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.
Public method GetSelectable Gets a value indicating whether this ShapeSubField is selectable.
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.
Public method IsNavigationKey(Char) Returns a value indicating whether the specified character corresponds to a navigational command.
Public method IsNavigationKey(Keys) Returns a value indicating whether the specified key data corresponds to a navigational command.
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.
Public method NavigateTo Sets the focus to the specified DiagramItem.
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.
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.
Public method NavigateToNext Called by this ShapeSubField to set focus to the next object in the navigation sequence.
Public method NavigateToPrevious Called by this ShapeSubField to set focus to the previous object in the navigation sequence.
Protected method OnBeginEdit Called when in-place editing has begun.
Public method OnClick Called by the control's OnClick().
Public method OnDoubleClick Called by the control's OnDoubleClick().
Protected method OnEndEdit Called when in-place editing has ended.
Public method OnKeyDown Called when a key is pressed. To be called, this ShapeSubField must be the focused ShapeSubField in the selection.
Public method OnKeyPress Called between a key down and key up. To be called, this ShapeSubField must be the focused ShapeSubField in the selection.
Public method OnKeyUp Called when a key is released. To be called, this ShapeSubField must be the focused ShapeSubField in the selection.
Public method OnMouseDown Called by the control's OnMouseDown().
Public method OnMouseMove Called by the control's OnMouseMove().
Public method OnMouseUp Called by the control's OnMouseUp().
Public method OnMouseWheel Called by the control's OnMouseWheel().
Public method SubFieldEquals Gets a value indicating whether this ShapeSubField and the specified ShapeSubField are equal.
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