ShapeSubField Class

Definition

Namespace:

Microsoft.VisualStudio.Modeling.Diagrams

Assembly:

Microsoft.VisualStudio.Modeling.Sdk.Diagrams.dll

Package:

Microsoft.VisualStudio.Modeling.Sdk.Diagrams v17.10.40171

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.

A future enhancement is to allow a subfield to represent multiple elements. For example, a single subfield could represent an entire column in a grid.

public ref class ShapeSubField abstract

public abstract class ShapeSubField

type ShapeSubField = class

Public MustInherit Class ShapeSubField

Inheritance

Object

ShapeSubField

Derived

Microsoft.VisualStudio.Modeling.Diagrams.ListItemSubField

Constructors

ShapeSubField()

Initializes a new instance of the ShapeSubField class.

Properties

SubFieldHashCode

Gets a hash code for this ShapeSubField.

Methods

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